Springboot springdoc-openapi 如何自定义swagger

Question

添加下面的依赖项可以访问 swagger ui。

<dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.6.0</version>
</dependency>

但是如何使用此依赖项编辑 Swagger 标题等。在 springfox 中，可以使用 docket bean。 springdocs 里怎么可能？

尝试编辑Springdocs的swagger。

Answer 1

有两个可以自定义您的 openapi 模板。

一般有两种方式：

1-通过java代码并创建bean配置：

第一种方法，是通过java代码配置它，在其中实现一个bean，并编写有关它的文档，它看起来像这样，但我不推荐它：

@Configuration
public class OpenApiConfig {

@Bean
public OpenAPI customOpenAPI() {
    return new OpenAPI()
            .info(new Info()
                    .title("Custom API Title")
                    .description("Custom API Description")
                    .version("1.0.0")
                    .contact(new Contact()
                            .name("API Support")
                            .url("http://example.com/contact")
                            .email("[email protected]"))
                    .license(new License()
                            .name("Apache 2.0")
                            .url("http://springdoc.org")))
            .externalDocs(new ExternalDocumentation()
                    .description("Full Documentation")
                    .url("http://example.com/docs"));
    }
}

2- yaml/属性配置

第二种方法是使用

springdoc-openapi

创建模板并创建 yml 或 properties 文件，其中包含有关 openapi 的文档，然后当您的应用程序运行时，您可以看到文档。

它看起来像这样：

springdoc:
  api-docs:
    path: /v3/api-docs
  swagger-ui:
    path: /swagger-ui.html
  info:
    title: Custom API Title
    description: Custom API Description
    version: 1.0.0
    contact:
      name: API Support
      url: http://example.com/contact
      email: [email protected]
    license:
      name: Apache 2.0
      url: http://springdoc.org
  external-docs:
    description: Full Documentation
    url: http://example.com/docs