文档api编写插件 Swagger2

187 阅读1分钟

为了减少程序员撰写文档,提高生产力,Swagger2应运而生,使用Swagger2可以减少编写过多的文档,只需要通过代码就能生成文档api提供给前端人员对接,非常方便。

1、引入依赖

<!--swagger2配置-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.4.0</version>
        </dependency>
        以上两个是官网提供的
        以下依赖也是ui但是是非官方的
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.6</version>
        </dependency>

2、编写配置类

package com.imooc.config;

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {

    // 访问地址: http://localhost:8088/swagger-ui.html
    //配置swagger2核心配置 -- docket
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2) // 指定api类型为swagger2
        .apiInfo(apiInfo()) // 用于定义api文档
        .select().apis(RequestHandlerSelectors.basePackage("com.imooc.controller")) // 指定controller包
        .paths(PathSelectors.any()) // 所有controller
        .build();
    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("天天吃货 电商平台接口api") // 文档页标题
                .contact(new Contact("imooc",
                        "https://www.imooc/com",
                        "abc@imooc.com")) // 联系人信息
                .description("专为天天吃货提供的api文档") // 详细信息
                .version("1.0.1") //文档版本号
                .termsOfServiceUrl("https://www.imooc/com") // 网站地址
                .build();
    }
}

3、访问效果

记得加的最后一个依赖,可以通过最后一个依赖进行换肤操作,很简单,访问路径不同。 现在需要访问 http://localhost:8088/doc.html 即可,效果图如下

4、@ApiIgnore,@Api,@ApiOperation,@ApiModel,@ApiModelProperty用法

如果想忽略controller包下的某些接口,可以添加@ApiIgnore

@Api添加controller类相关注释

@ApiOperation添加接口相关注释

效果图

@ApiModel与@ApiModelProperty为实体类相关注释。

用法:

效果图: