swagger 配置

最新推荐文章于 2024-04-17 16:51:40 发布

原创最新推荐文章于 2024-04-17 16:51:40 发布 · 781 阅读

0 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#swagger 配置

收录于

swagger 专栏收录该内容

1 篇文章

订阅专栏

本文介绍如何在SpringBoot项目中集成Swagger2来生成RESTful API文档，通过注解和配置创建Docket实例，指定扫描的Controller包路径，自定义API信息如标题、描述和版本。

package com.basetnt.bss;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        Docket docket =  new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.basetnt.bss.controller"))
                .paths(PathSelectors.any())
                .build();
        docket.forCodeGeneration(true);
        return docket;
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("bss api")
                .description("bss API list")
                .version("1.0")
                .build();
    }
}