现如今的程序开发，很多采用前后端分离的模式，前端人员负责调用接口、进行渲染，后端人员专注代码实现，前端和后端的唯一联系变成了API接口。因此，API文档变得越来越重要。为了让大家快速掌握API文档，千锋郑州Java培训老师给大家介绍一个比较好用的框架——swagger。

　　目前大部分Java程序员与前端对接采取的方式是：Vue + SpringBoot，Vue通过JS渲染页面，后端把数据传递给JS，早期前端只负责写页面，然后把写好的HTML页面给后端，后端使用模板引擎(JSP，Thymeleaf、freemarker)进行开发。

　　前后端分离的好处：各自开发、相对独立、松耦合，前后端通过API进行交互，后端提供接口给前端，前端去调用该接口，但可能会导致前后端团队人员不能做到及时协商，出现一些问题。解决方式：早期使用实时更新文档，但非常繁琐，后来又使用postman来进行一些测试。

　　swagger是一个方便我们更好的编写API文档的框架，而且swagger可以模拟HTTP请求调用。

　　SpringBoot中集成swagger使用步骤：

　　1.创建SpringBoot工程，然后导入依赖

　　io.springfox

　　springfox-swagger-ui

　　2.9.2

　　io.springfox

　　springfox-swagger2

　　2.9.2

　　2.创建配置类

　　@Configuration

　　@EnableSwagger2//开启Swagger2

　　public class SwaggerConfig {

　　然后启动测试运行。

　　3.手动配置实例，修改SwaggerConfig配置类

　　package com.qf.swagger.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;

　　@Configuration

　　@EnableSwagger2//开启Swagger2

　　public class SwaggerConfig {

　　//配置Swagger的Bean实例

　　@Bean

　　public Docket swaggerSpringMvcPlugin() {

　　return new Docket(DocumentationType.SWAGGER_2)

　　.apiInfo(apiInfo());

　　//配置API的基本信息(会在http://项目实际地址/swagger-ui.html页面显示)

　　private ApiInfo apiInfo() {

　　return new ApiInfoBuilder()

　　.title("测试API文档标题")

　　.description("测试api接口文档描述")

　　.termsOfServiceUrl("http://www.baidu.com")

　　.version("1.0")

　　.build();

　　然后再次重启测试运行：

　　swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息

　　@Api：修饰整个类，描述Controller的作用

　　@ApiOperation：描述一个类的一个方法，或者说一个接口

　　@ApiModel：用对象来接收参数 ，修饰类

　　@ApiModelProperty：用对象接收参数时，描述对象的一个字段

　　@ApiResponse：HTTP响应其中1个描述

　　@ApiResponses：HTTP响应整体描述，一般描述错误的响应

　　@ApiIgnore：使用该注解忽略这个API

　　@ApiError ：发生错误返回的信息

　　@ApiParam：单个参数描述

　　@ApiImplicitParam：一个请求参数，用在方法上

　　@ApiImplicitParams：多个请求参数

　　想了解更多Java进阶知识点，你可以关注“千锋郑州校区”微信公众号，会有专业的授课老师分享讲解知识点，让你了解最新潮流的技术。你也可以来千锋郑州Java培训班学习进阶，跟随大牛讲师面对面学习交流，积累更多实战经验。

上一篇

云计算应用场景迎来大爆发 快速入行云计算就选千锋

下一篇

千锋逆战班学员分享心得体会：努力是学习的捷径