Spring Boot Swagger2

Swagger的由来

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

其他API文档工具

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

使用方法

• 在pom.xml中引入依赖

  
  swagger.dependence.png

• 在应用主类（例如：SpringDataJpaApplication）中增加@EnableSwagger2Doc注解

  
  springdatajpaapplication.png

• 参数配置
  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=RanRan Tao swagger.contact.url=https://www.jianshu.com/u/822585e5c69a swagger.contact.email=16422802@qq.com swagger.base-package=com.example.springdatajpa.controller swagger.base-path=/** swagger.exclude-path=/error, /ops/**