springboot 集成 swagger

本文讲述基于 springboot 开发的项目如何集成 swagger。swagger 是用于自动生成 API 接口文档的工具。和传统 API 接口定义的最大区别是, 该方式是将接口的定义放在代码中，这样的好处是，当接口发生变动时，可以顺手就把接口定义改了，而不用再切换到其它的环境，提高了工作效率，也避免了因为程序员的懒惰而导致的接口实现和定义不同步。生成的接口定义文档还支持在线测试。

集成方式有 2 种:

• 原生方式 只能通过 java 类方式进行配置，不够灵活。
• starter 方式 推荐该方式，可通过配置文件定义 swagger 配置

通过 swagger-spring-boot-starter 集成 swagger

• 添加依赖

compile 'com.spring4all:swagger-spring-boot-starter:1.9.0.RELEASE'

• 修改配置文件

#swagger配置
swagger:
  base-path: /**
  base-package: 'com.ruiboyun.**.controller'
  title: '远程面试项目的API文档'
  description: ''
  version: '1.0'

提示

若项目中集成了认证授权框架 shiro，则需要对 swagger api 文档的资源访问路径做"匿名访问"配置, 配置方法详见创建 shiro 配置类