Springboot 集成 Swagger2使用

文章目录

• • • WHAT
    • WHY
    • HOW

WHAT

后台服务接口文档

WHY

1. 可以直接在编写代码的时候，顺便把接口文档写了。
2. 便于测试接口

HOW

1. 导包

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>
           

1. 配置文件

package com.komlin.user.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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Auther: albert
 * @Date: 2019-03-06 09:44
 * @Description:
 */
@Configuration
//开启Swagger
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.komlin"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("用户服务")
                .description("关于用户服务接口文档")
                .termsOfServiceUrl("http://127.0.0.1/api/user-service/")
                .version("1.0")
                .build();
    }
}

           

1. 接口通过注解编写

   @Api()：作用于类上，表示这个类是swagger的资源。

   tags = ”说明该类的作用“

   @ApiOperation()：用在请求的方法上，说明的方法的用户和作用

   value=“说明方法的用途、作用”

   notes="方法的备注说明“

   @ApiImplicitParams()：用在请求的方法上，表示一组参数说明，可以包含多个@ApiImplicitParam()

   @ApiImplicitParam()：指定一个请求参数的各个方面

   name：参数名

   value：参数的汉字说明

   required：参数是否必须传

   dataType：参数类型

   defaultValue：参数的默认值

   @ApiResponses()：用在请求的方法上，表示一组响应。可以包含多个@ApiResponse()

   @ApiResponse()：用于表示一个错误的响应信息

   code：数字

   message：信息

   response：抛出异常的类

   @ApiModel()：用在响应类上，表示一个返回响应数据的信息。

   @ApiModelProperty()：用在属性上，描述响应类的属性

2. 查看接口文档

   输入http:port/swagger-ui.html