【Java】Swagger2介绍与整合Swagger2过程：

1.官方地址： https://swagger.io/

2.手写Api文档的几个痛点：文档需要更新的时候，需要再次发送一份给前端，也就是文档更新交流不及时。接口返回结果不明确不能直接在线测试接口，通常需要使用工具，比如postman 接口文档太多，不好管理

Swagger也就是为了解决这个问题，通过一些配置可以生成文档，当然也不能说Swagger就一定是完美的，当然也有缺点，最明显的就是代码移入性比较强。

3.APi一览：

 1@Api：用在请求的类上，表示对类的说明
 2tags="说明该类的作用，可以在UI界面上看到的注解"
 3value="该参数没什么意义，在UI界面上也看到，所以不需要配置"
 4@ApiOperation：用在请求的方法上，说明方法的用途、作用
 5value="说明方法的用途、作用"
 6notes="方法的备注说明"
 7@ApiImplicitParams：用在请求的方法上，表示一组参数说明
 8@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
 9name：参数名
10value：参数的汉字说明、解释
11required：参数是否必须传
12paramType：参数放在哪个地方
13· header --> 请求参数的获取：
14@RequestHeader· query --> 请求参数的获取：
15@RequestParam· path（用于restful接口）--> 请求参数的获取：
16@PathVariable· body（不常用）
17· form（不常用）    
18dataType：参数类型，默认String，其它值dataType="Integer"       
19defaultValue：参数的默认值
20@ApiResponses：用在请求的方法上，表示一组响应
21@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
22code：数字，例如400message：信息，例如"请求参数没填好"response：抛出异常的类
23@ApiModel：用于响应类上，表示一个返回响应数据的信息
24（这种一般用在post创建的时候，使用@RequestBody这样的场景，
25请求参数无法使用@ApiImplicitParam注解进行描述的时候）
26@ApiModelProperty：用在属性上，描述响应类的属性

4.SpringMVC配置Swagger2：首先你先有个Spring+SpringMVC项目，接下来继续配置：

4.1 pom.xml继续配置：

 1<!-- swagger2 start -->
 2<dependency>
 3   <groupId>io.springfox</groupId>
 4   <artifactId>springfox-swagger2</artifactId>
 5   <version>2.7.0</version></dependency>
 6<dependency>
 7    <groupId>io.springfox</groupId>
 8    <artifactId>springfox-swagger-ui</artifactId>
 9    <version>2.7.0</version>
10</dependency>
11<!--  swagger2 end -->

4.2 假设项目包名 com.naton 创建文件夹：com.naton.conf conf目录下创建文件：SwaggerConfig.java: 代码：

 1package com.naton.config;
 2import org.springframework.context.annotation.Bean;
 3import org.springframework.context.annotation.Configuration;
 4import springfox.documentation.builders.ApiInfoBuilder;
 5import springfox.documentation.builders.RequestHandlerSelectors;
 6import springfox.documentation.service.ApiInfo;
 7import springfox.documentation.spi.DocumentationType;
 8import springfox.documentation.spring.web.plugins.Docket;
 9import springfox.documentation.swagger2.annotations.EnableSwagger2;
10@Configuration
11@EnableSwagger2
12public class SwaggerConfig {
13@Bean    
14public Docket api() {        
15return new Docket(DocumentationType.SWAGGER_2)
16    .select()
17    .apis(RequestHandlerSelectors.any())
18    .build()
19    .apiInfo(apiInfo());
20    }   
21private ApiInfo apiInfo() {        
22        return new ApiInfoBuilder()
23        .title("对外开放接口API 文档")
24            .description("HTTP对外开放接口")
25        .version("1.0.0")
26        .termsOfServiceUrl("http://localhost:8080")
27        .license("LICENSE")
28        .licenseUrl("http://localhost:8080")
29        .build();
30    }
31}

4.3为了访问swagger-ui.html，我们配置对这些静态资源的访问,创建文件：WebAppConfig.java

 1package com.naton.config;
 2import org.springframework.context.annotation.Configuration;
 3import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 4import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
 5import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 6@Configuration
 7@EnableWebMvc
 8public class WebAppConfig extends WebMvcConfigurerAdapter {    
 9    @Override 
10    public void addResourceHandlers(ResourceHandlerRegistry registry) {
11        registry.addResourceHandler("swagger-ui.html")
12    .addResourceLocations("classpath:/META-INF/resources/");
13        registry.addResourceHandler("/webjars/**")
14    .addResourceLocations("classpath:/META-INF/resources/webjars/");
15    }
16}

4.4测试地址：http://localhost:端口/项目名字/swagger-ui.html

4.5接口配置：

 1@Api：修饰整个类，描述Controller的作用
 2@ApiOperation：描述一个类的一个方法，或者说一个接口
 3@ApiParam：单个参数描述
 4@ApiModel：用对象来接收参数
 5@ApiProperty：用对象接收参数时，描述对象的一个字段
 6@ApiResponse：HTTP响应其中1个描述
 7@ApiResponses：HTTP响应整体描述
 8@ApiIgnore：使用该注解忽略这个API
 9@ApiError ：发生错误返回的信息
10@ApiImplicitParam：一个请求参数
11@ApiImplicitParams：多个请求参数

示例：

 1/**
 2 * 同步数据
 3 * 
 4 * @param param
 5 * @return
 6 */
 7@ApiOperation(value = "获取所有产品信息", notes = "获取所有产品信息", httpMethod = "GET")
 8@ResponseBody
 9@RequestMapping(value="/sync/test", method = RequestMethod.GET)
10public JSONMessage test(String value,String notes) {    
11    return JSONMessage.success("测试功能");
12}

5.注意点：

swagger2文档建议在开发环境下使用，生产环境需要注释掉或者隐藏到登录后面。

6.springBoot配置Swagger2过程与SpringMVC配置差不多：
pom.xml配置与上面引入的maven库一样，在新建一个文件配置：

 1import org.springframework.context.annotation.Bean;  
 2import org.springframework.context.annotation.Configuration;  
 3import springfox.documentation.builders.ApiInfoBuilder;  
 4import springfox.documentation.builders.PathSelectors;  
 5import springfox.documentation.builders.RequestHandlerSelectors;  
 6import springfox.documentation.service.ApiInfo;  
 7import springfox.documentation.spi.DocumentationType;  
 8import springfox.documentation.spring.web.plugins.Docket;  
 9import springfox.documentation.swagger2.annotations.EnableSwagger2;  
10@Configuration  
11@EnableSwagger2  public class Swagger2 {  
12    @Bean  
13    public Docket createRestApi() {  
14        return new Docket(DocumentationType.SWAGGER_2)  
15            .apiInfo(apiInfo())  
16            .select()  
17            .apis(RequestHandlerSelectors.basePackage("com.naton"))  
18            .paths(PathSelectors.any())  
19            .build();  
20    }  
21    private ApiInfo apiInfo() {  
22        return new ApiInfoBuilder()  
23            .title("Spring Boot中使用Swagger2构建RESTful APIs")  
24            .description("描述内容")  
25            .termsOfServiceUrl("https://baidu.com")  
26            .contact("LuWenhui")  
27            .version("1.0")  
28            .build();  
29    }  
30}

【Java】Swagger2介绍与整合Swagger2过程：

猜你喜欢