首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >springdoc ui swagger 3更改API描述

springdoc ui swagger 3更改API描述
EN

Stack Overflow用户
提问于 2022-04-28 02:12:36
回答 2查看 3K关注 0票数 4

我对String和Swagger 3很陌生。如何更改默认的API描述,即Swagger springdoc-openapi-ui swagger 3中的OpenAPI definition

还有版本,开发者信息..。

我在用

代码语言:javascript
复制
implementation "org.springframework.boot:spring-boot-starter-web:2.6.6"
implementation "org.springdoc:springdoc-openapi-ui:1.6.8"

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

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2022-05-03 20:57:51

只需使用以下注释:

应用程序启动程序类中的(配置类):

代码语言:javascript
复制
@OpenAPIDefinition(info=@Info(title="Name of project"))

控制器中的

代码语言:javascript
复制
import io.swagger.v3.oas.annotations.*

Calss级别:

代码语言:javascript
复制
@OpenAPIDefinition()

代码语言:javascript
复制
@Tag(name = "", description = "")

方法级别:

代码语言:javascript
复制
 @Operation()

 @ApiResponses()
票数 4
EN

Stack Overflow用户

发布于 2022-10-25 12:20:57

对于我使用的标准版本:

代码语言:javascript
复制
@Bean
    public OpenAPI customOpenAPI() {
        final String locUrl = "http://localhost:8080";
        final String devUrl = "https://.de";
        final String testUrl = "https://.de";
        final String preUrl = "https://.de";
        final String proUrl = "https://.grp";

        return new OpenAPI().addServersItem(new Server().url(locUrl)).addServersItem(new Server().url(
                devUrl)).addServersItem(new Server().url(testUrl)).addServersItem(new Server().url(preUrl))
            .addServersItem(new Server().url(proUrl)).info(
                new Info().version("v1").title("XApp application API")
                    .description("(NOTE: If having Swagger UI issues w/ Chrome then use Firefox instead.)")
            .contact(new Contact().name("Edi")));
    }

为了根据分组进行改变,我做到了:

代码语言:javascript
复制
@Profile("!dev")
    @Bean
    public GroupedOpenApi groupedPublicOpenApi10() {
        return GroupedOpenApi
            .builder()
            .addOpenApiCustomiser(openApi -> openApi.getInfo().setVersion("v1"))
            .group("API-v1")
            .pathsToMatch("/api/**")
            .displayName("API v1")
            .build();
    }
票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/72037222

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档