OpenAPI3&Spring Boot 自定义配置（简介明了）

_YouRaiseMeUp_

已于 2022-06-14 18:35:20 修改

阅读量997

点赞数 2

文章标签： spring boot java restful

于 2022-05-31 22:50:21 首次发布

本文链接：https://blog.csdn.net/YaoguoHH/article/details/125074843

版权

本文详细介绍了如何在Spring Boot应用中配置OpenAPI3，包括DocProperties和DocConfiguration的设置，以及pom.xml和application.yaml的相关配置，旨在提供清晰的RESTful API文档定制方法。

摘要由CSDN通过智能技术生成

OpenAPI3&Spring Boot 自定义配置

DocProperties

@Data
@ConfigurationProperties("doc.info")
public class DocProperties {
   

    /**
     * 分组名称
     */
    private String group       = "default";
    /**
     * 标题
     */
    private String title       = "API";
    /**
     * 描述
     */
    private String description = "RESTFUL API";
    /**
     * 版
     */
    private String version     = "v2.0.0";
    /**
     * 接口调用地址
     */
    private String serverUrl;
    /**
     * 执照
     */
    private String license     = "Apache 2.0";
    /**
     * 执照地址
     */
    private String licenseUrl  = "https://www.apache.org/licenses/LICENSE-2.0.html";

    /**
     * 全局安全配置
     */
    private List<SecurityScheme> securitySchemes = Lists.newArrayList();}

DocConfiguration

Doc 基础信息配置
认证配置
全局变量配置

@Slf4j
@AllArgsConstructor
@EnableConfigurationProperties(DocProperties.class)
public class DocConfiguration {
   

    private final DocProperties docProperties;

    /**
     * Api docket.
     *
     * @return the docket
     */
    @Bean
    public GroupedOpenApi api()