【问题标题】:Swagger not showing API Models and not ignoring default response codesSwagger 不显示 API 模型并且不忽略默认响应代码
【发布时间】:2021-05-11 06:24:52
【问题描述】:

如标题中所述 - Swagger 不显示 API 模型并且不忽略默认响应代码

我已经把源代码上传到-https://bitbucket.org/vambits/inactiveaccounts/src/master/
git clone https://bitbucket.org/vambits/inactiveaccounts.git

  1. 我不确定为什么 API 模型对象:SimpleRequestSimpleResponse 没有出现在 Swagger UI 中。
    如您所见,末尾没有“模型”。

  2. 在代码中,我设置了.build()).useDefaultResponseMessages(false),但仍显示默认响应代码。如何解决这个问题?

注意:此应用程序的功能无关紧要。

Swagger Docket 配置如下 -

@Bean
    public Docket swaggerApi()
    {
        return new Docket(DocumentationType.SWAGGER_2).protocols(Sets.newHashSet("http", "https"))
                /*
                 * Make sure swagger doesn't auto-generate error responses that we won't be using (e.g. 401, 403)
                 */
                /*
                 * Since SpringFox doesn't support the @SwaggerDefinition, specify that metadata here
                 */
                .apiInfo(new ApiInfoBuilder().title("InactiveAccountsApplication Pricing").version("1")
                        .contact(new Contact("InactiveAccountsApplication Services", null, "abc-services@xyz.com"))
                        .description(
                                "InactiveAccountsApplication returns the inactive accounts list")
                        .build())
                        .useDefaultResponseMessages(false)

                .select()
                
                .apis(RequestHandlerSelectors.basePackage(InactiveAccountsApplication.class.getPackage().getName()))
                .paths(PathSelectors.any()).build();
    } 

【问题讨论】:

    标签: spring spring-boot swagger swagger-ui


    【解决方案1】:

    我建议使用 springdoc 而不是 springfox 库,因为它们已经过时了。

            <dependency>
                <groupId>org.springdoc</groupId>
                <artifactId>springdoc-openapi-ui</artifactId>
                <version>1.5.8</version>
            </dependency>
    

    Here 你可以找到包含迁移指南的文档

    那么模型应该是开箱即用的。

    关于你的第二个问题:

    屏幕截图中显示的响应代码不是默认响应消息。它们是您在控制器中描述的响应,所以我不明白问题是什么。

    【讨论】:

    • 感谢您指出我在第二部分遗漏的内容(我没有意识到我后来更改了它)。
    • 在第一部分 - 我没有从 springfox 更改的灵活性。它在组织方面很有用,我应该只去。关于在使用 springfox 时如何修复它的任何建议
    • 似乎在第一部分,我错过了一些简单但难以发现的东西
    • 我不确定 OpenAPI v2 是否有单独的模型部分,因为在您的示例中,模型已经在请求中。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-03-28
    • 2013-08-06
    • 1970-01-01
    • 2015-05-08
    • 1970-01-01
    • 2021-08-06
    相关资源
    最近更新 更多