Swagger示例

对于项目完成后不用写文档,好处还是蛮大的

不需要关注项目其他只关注接口与实体类即可

SpringBoot项目

依赖



    io.springfox
    springfox-swagger2
    2.9.2




    io.springfox
    springfox-swagger2
    2.9.2

启动类或者配置类添加开启Swagger注解

对于SpringBoot版本2.6以上的需要配置文件里加个配置不然启动报错(设置个路径)

SpringBoot版本2.6以上,需要在配置文件里假如  解决SpringBoot2.6.2使用Swagger的问题

浏览器访问: http://ip:port/上下文/swagger-ui.html

可以写个Swagger配置类


@Configuration
public class SwaggerConfig {
 
    //配置Swagger docket的bean实例
    @Bean
    public Docket docket(){
 
        //1.创建Docket对象
        Docket docket=new Docket(DocumentationType.SWAGGER_2);
 
        //2.创建API信息,接口文档总体描述
        /**
         * 使用指定的信息构造 ApiInfo 的实例。
         *
         * @param title               API 的标题。
         * @param description         API 的描述。
         * @param version             API 的版本。
         * @param termsOfServiceUrl   API 的服务条款 URL。
         * @param contact             API 的联系信息。
         * @param license             API 的许可证信息。
         * @param licenseUrl          API 许可证的 URL。
         * @param vendorExtensions    要包含在 API 文档中的额外供应商扩展。
         */
        ApiInfo apiInfo=new ApiInfoBuilder()
                .title("图书馆管理系统 API")
                .version("1.0.0")
                .description("前后端分离项目,前端vue,后端SpringBoot+Dubbo分布式项目")
                .contact(new Contact("hrui", "www.hrui.com", "376084295@qq.com"))
                .license("Apache 2.0")
                .licenseUrl("http://www.opensource.org/licenses/mit-license.php")
                .build();
        //3.使用ApiInfo
        docket = docket.apiInfo(apiInfo);
        //4.设置参与文档生成的包
        docket=docket.select().apis(RequestHandlerSelectors.basePackage("com.example.controller")).build();
        return docket;
 
    }
 
 
}