Swagger2的使用

第一步：引入相关jar包：

<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>

第二步：编写swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等

@Configuration

@EnableSwagger2

public class Swagger2 {

    /**

    * @Description:swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等

    */

    @Bean

    public Docket createRestApi() {

        // 为swagger添加header参数可供输入

        ParameterBuilder userTokenHeader =new ParameterBuilder();

        ParameterBuilder userIdHeader =new ParameterBuilder();

        List pars =new ArrayList();

        userTokenHeader.name("headerUserToken").description("userToken")

        .modelRef(new ModelRef("string")).parameterType("header")

        .required(false).build();

        userIdHeader.name("headerUserId").description("userId")

        .modelRef(new ModelRef("string")).parameterType("header")

        .required(false).build();

        pars.add(userTokenHeader.build());

        pars.add(userIdHeader.build());

        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select()

        .apis(RequestHandlerSelectors.basePackage("com.example.demo.Controller"))

        .paths(PathSelectors.any()).build()

        .globalOperationParameters(pars);

    }

    /**

    * @Description: 构建 api文档的信息

    */

    private ApiInfo apiInfo() {

        return new ApiInfoBuilder()

        // 设置页面标题

                .title("使用swagger2构建短视频后端api接口文档")

        // 设置联系人

       .contact(new Contact("imooc-风间影月","http://www.imooc.com","imooc@163.com"))

        // 描述

       .description("欢迎访问短视频接口文档，这里是描述信息")

        // 定义版本号

        .version("1.0").build();

    }

}

第三步：测试一下：

@RestController

@Api(value ="aaa", tags = {"这是玩的"})

public class DemoController {

    @ApiOperation(value ="方法", notes ="这是aa方法")

    @PostMapping("/aa")

    public Object bbb() {

        return "aaaa";

}