springdoc-openapi-ui swagger 3 更改 API 描述

Question

我是 String 和 Swagger 3 的新手。如何更改OpenAPI definitionSwagger 中的默认 API 描述springdoc-openapi-ui swagger 3

还有版本、开发者信息..

我在用

implementation "org.springframework.boot:spring-boot-starter-web:2.6.6"
implementation "org.springdoc:springdoc-openapi-ui:1.6.8"

在搜索中，我只看到它们显示默认的 Swagger UI

Answer 1

只需使用以下注释：

在应用程序启动器类（配置类）中：

@OpenAPIDefinition(info=@Info(title="Name of project"))

在控制器中导入应如下所示：

import io.swagger.v3.oas.annotations.*

班级等级：

@OpenAPIDefinition()

或者

@Tag(name = "", description = "")
public class ApiController {

方法级别：

@PutMapping(value = "/test")
@Operation(summary = "info...")
@ApiResponses(value = {
        @ApiResponse(responseCode = "200", description = "successfully updated"),
        @ApiResponse(responseCode = "400", description = "Bad request"),
        @ApiResponse(responseCode = "500", description = "Internal Server Error")})

配置类应该是这样的：

@Configuration
public class ApiDocumentationConfig {

    @Bean
    public OpenAPI apiDocConfig() {
        return new OpenAPI()
                .info(new Info()
                        .title("example API")
                        .description("example API for routing ")
                        .version("0.0.1")
                        .contact(new Contact()
                                .name("example")
                                .email("exaample@z.com")))
                .externalDocs(new ExternalDocumentation()
                        .description("Documentation")
                        .url("https:/wiki...."));
    }

    @Bean
    public MvcConfig mvcConfig() {
        return new MvcConfig();
    }