3 使用swagger2轻松生成在线接口文档

swagger的由来

随着互联网技术的发展，现在的网站架构基本都由原来的后端渲染，变成了：前端渲染、先后端分离的形态，而且前端技术和后端技术在各自的道路上越走越远。
前端和后端的唯一联系，变成了API接口；API文档变成了前后端开发人员联系的纽带，变得越来越重要，swagger就是一款让你更好的书写API文档的框架。

其他API文档工具

• confluence
• README.md
• rap——API文档工具，阿里开发，rap2官网
• swagger——API文档框架，swagger官网

swagger生态图

image

swagger UI 使用方法（选了一种适度封装之后的）

• 在pom.xml中引入依赖

   <dependency>
      <groupId>com.spring4all</groupId>
        <artifactId>swagger-spring-boot-starter</artifactId>
        <version>1.8.0.RELEASE</version>
      </dependency>

• 在应用主类中增加@EnableSwagger2Doc注解

@SpringBootApplication
@EnableSwagger2Doc
public class Springboot2Swagger2Application {

    public static void main(String[] args) {
        SpringApplication.run(Springboot2Swagger2Application.class, args);
    }
}

默认情况下就能产生所有当前SpringMVC加载的请求映射文档

访问地址：http://localhost:8080/swagger-ui.html

• 参数配置示例

swagger.enabled=true
swagger.title=spring-data-jpa module
swagger.description=Starter for swagger 2.x
swagger.license=Apache License, Version 2.0
swagger.licenseUrl=https://www.apache.org/licenses/LICENSE-2.0.html
swagger.termsOfServiceUrl=https://github.com/dyc87112/spring-boot-starter-swagger
swagger.contact.name=mqXu
swagger.contact.url=https://www.jianshu.com/u/822585e5c69a
swagger.contact.email=moqi1977@gmail.com
swagger.base-package=com.springboot.mybatis.controller
swagger.base-path=/**
swagger.exclude-path=/error, /ops/**

swagger UI整体效果

image

这下，离开postman也可以愉快地测试接口了，并且很方便地生成了在线的接口文档，方便前后端联调，再也不会滞后了。