在openapi中自定义可分页显示

Question

我正在做一个spring boot项目，使用OPENAPI作为api文档的工具。

我试图用直观的输入（page-pageSize-sort）覆盖UI中可分页json对象的显示

   public OperationCustomizer parameterCustomizer() {
        return (Operation operation, HandlerMethod handlerMethod) -> {

            Parameter page = new Parameter()
                    .in(ParameterIn.QUERY.toString())
                    .schema(new IntegerSchema()._default(0))
                    .name("page")
                    .description("La page (0..N)")
                    .required(true);
            Parameter size = new Parameter()
                    .in(ParameterIn.QUERY.toString())
                    .schema(new IntegerSchema()._default(10))
                    .name("pageSize")
                    .description("Nombre de résultats par page")
                    .required(true);
            Parameter sort = new Parameter()
                    .in(ParameterIn.QUERY.toString())
                    .schema(new ArraySchema())
                    .name("sort")
                    .description("Critère de tri avec le format: property(,asc|desc). "
                            + "Tri par défaut: ascendant. "
                            + "Multiple critères de tri sont supportés.");
            if(operation.)
            operation.addParametersItem(page);
            operation.addParametersItem(size);
            operation.addParametersItem(sort);
            return operation;
        };
    }

这是可行的，但是参数页面、页面大小和排序被添加到所有方法中。我如何才能使这只适用于需要可分页的方法？

Answer 1

找到它！我必须在handlerMethod中检查参数类型中是否存在可分页类：

    public OperationCustomizer parameterCustomizer() {
        return (Operation operation, HandlerMethod handlerMethod) -> {
            if (Arrays.asList(handlerMethod.getMethod().getParameterTypes()).contains(Pageable.class)) {
                Parameter page = new Parameter()
                        .in(ParameterIn.QUERY.toString())
                        .schema(new IntegerSchema()._default(0))
                        .name("page")
                        .description("La page (0..N)")
                        .required(true);
                Parameter size = new Parameter()
                        .in(ParameterIn.QUERY.toString())
                        .schema(new IntegerSchema()._default(10))
                        .name("pageSize")
                        .description("Nombre de résultats par page")
                        .required(true);
                Parameter sort = new Parameter()
                        .in(ParameterIn.QUERY.toString())
                        .schema(new ArraySchema())
                        .name("sort")
                        .description("Critère de tri avec le format: property(,asc|desc). "
                                + "Tri par défaut: ascendant. "
                                + "Multiple critères de tri sont supportés.");
                operation.addParametersItem(page);
                operation.addParametersItem(size);
                operation.addParametersItem(sort);
            }
            return operation;
        };
    }