【问题标题】:swagger ui is not showing unused modelswagger ui 未显示未使用的模型
【发布时间】:2021-07-19 16:09:09
【问题描述】:

swagger ui 是否只显示控制器使用的模型?

在我的 Spring Boot 应用程序中,我使用 swagger 2 来定义我的 api。很少有模型在 apis 中使用,而其他模型没有直接使用,但我需要在我的 api 文档中使用它们。 现在,当我在 swagger 编辑器中看到 json 时,它完美地显示了所有内容,但 swagger ui 仅显示控制器使用的模型。以下是我的 swagger-ui 配置

@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.search.controller"))
            .paths(PathSelectors.any())
            .build();
}

如果有人可以就此分享一些反馈,将会很有帮助。还有其他工具可以达到这个目的吗?

谢谢

【问题讨论】:

  • 如果您正在创建一个新项目,请考虑使用“springdoc-openapi”(基本上是 swagger3,在 Spring 中具有更好的集成)。它只需要一个依赖项,并且不需要任何类型的配置即可进行基本使用。又名,开箱即用......
  • 是的,我认为 Swagger 只记录您的 API 端点...

标签: spring swagger swagger-ui


【解决方案1】:

您可以查看生成的 json 或 yaml 文件:

  • localhost:8080/v2/api-docs
  • localhost:8080/v2/api-docs.yaml

根据自己的喜好对其进行编辑,并改用您自己的文档源。

(这可能会有所帮助: http://editor.swagger.io)

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-02-01
    • 1970-01-01
    • 1970-01-01
    • 2021-09-15
    • 1970-01-01
    相关资源
    最近更新 更多