swagger简介：

swagger是一款开源的api接口文档生成工具。

Swagger的项目主页：https://swagger.io/ 目前比较流行的做法是在代码中加入swagger相关的注释，然后，利用小工具生成swagger.json或者swagger.yaml文件。

springboot将swagger变得更加简单：

springboot拥有自己的自动配置特性，而swagger也发布了应用于springboot的自动依赖配置模块。

也就是说，只需要在pom文件中引入swagger模块配置信息，然后在application中进行swagger框架的简单配置，即可轻松通过浏览器访问由swagger为我们生成的网页版接口说明文档。

具体步骤：

1.首先我们需要在pom.xml中加入swagger模块配置信息，将swagger模块引入到项目中：

        <!-- https://mvnrepository.com/artifact/com.spring4all/spring-boot-starter-swagger --><dependency><groupId>com.spring4all</groupId><artifactId>spring-boot-starter-swagger</artifactId><version>1.5.1.RELEASE</version></dependency>

2.在springboot启动类中加入注解：

@EnableSwagger2Doc
@SpringBootApplication
public class Bootstrap {public static void main(String[] args) {SpringApplication.run(Bootstrap.class, args);}
}

3.加入swagger配置信息：

在网上看到有两种配置方式，一种是另起一个application.yaml，然后通过yaml语言进行配置，另一种方式是在已有的application.properties中加入配置（这里记载第二种方式）：

#swagger配置信息
swagger.title=yyh project online API specification
swagger.description=the web page which you opened is generated by swagger automatically
swagger.version=1.5.0.RELEASE
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=mht
swagger.contact.url=http://localhost:8080/swagger-ui.html
swagger.contact.email=haotian.mou@ahav.com.cn
swagger.base-package=com.seco
swagger.base-path=/**

#配置说明：
swagger.title=标题
swagger.description=描述
swagger.version=版本
swagger.license=许可证
swagger.licenseUrl=许可证URL
swagger.termsOfServiceUrl=服务条款URL
swagger.contact.name=维护人
swagger.contact.url=维护人URL
swagger.contact.email=维护人email
swagger.base-package=swagger扫描的基础包，默认：全扫描
swagger.base-path=需要处理的基础URL规则，默认：/**
swagger.exclude-path=需要排除的URL规则，默认：空

4.API文档效果查看：

启动项目，打开浏览器在地址栏输入如下地址即可查看生成的API文档：

http://localhost:8080/swagger-ui.html

参考文章：

《简化Swagger使用的自制Starter：spring-boot-starter-swagger，欢迎使用和吐槽》

《使用spring-boot-starter-swagger实现API文档化》

《5分钟了解swagger》

==============================2018-8-8 ，星期三，下午，更新 ==============================

Spring Boot+shiro拦截swagger路径问题解决

在shiro拦截器配置方法中，加入对swagger的开发路径即可，如下代码所示

    /*** 配置shiro拦截器，用于url，粗粒度拦截* <br>作者： mht<br> * 时间：2018年8月3日-上午10:29:07<br>* @return*/@Beanpublic ShiroFilterChainDefinition chain() {DefaultShiroFilterChainDefinition chain = new DefaultShiroFilterChainDefinition();chain.addPathDefinition("/users/login", "anon");// 除了以上url剩下的都需要登录 TODO:拦截后的跳转功能//swagger接口权限 开放4个路径chain.addPathDefinition("/swagger-ui.html", "anon");chain.addPathDefinition("/webjars/**", "anon");chain.addPathDefinition("/v2/**", "anon");chain.addPathDefinition("/swagger-resources/**", "anon");chain.addPathDefinition("/**", "authc");return chain;}

注：其中，/webjars/** 和 /v2/** 也是swagger 的相关资源路径，需要一同开放。

Swagger自动接口文档生成框架————springboot整合swagger总结相关推荐

Popular MVC框架swagger+knif4j接口文档工具使用示例
Popular MVC框架swagger接口文档工具使用示例简介此项目介绍如何使用popularmvc内置的swagger+knife4j实现简单易用的实时API文档,支持在线调试接口! 此项目只 ...
扔掉Swagger，试试这款功能强大，零注解侵入的API接口文档生成工具！
欢迎关注方志朋的博客,回复"666"获面试宝典介绍 smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,smart-d ...
spring-boot 一款无侵入型，轻量级的接口文档生成工具apiggs
spring-boot 一款无侵入型,轻量级的接口文档生成工具apiggs 名字叫:apiggs 使用只需两步,先把插件代码引入pom文件,然后编译打包即可之后项目的target目录下,就会多出一个 ...
Swagger:搭建Swagger API接口文档
文章目录 Swagger 1.1导语: 1.2 Swagger是什么?它能干什么? 1.3Swagger简介 1.4 Swaggerr特点: SpringBoot 集成Swagger 1. 导包 2. ...
放弃丑陋的 swagger-ui，使用 knife 接口文档生成神器
文章目录接口生成利器 knife 介绍 springboot 整合 knife pom.xml 文件增加依赖编写Swagger2Config配置文件注意事项总结 knife Gitee 地址: ...
一款零注解API接口文档生成工具
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具,基于接口源码来分析生成接口文档,不采用任何注解侵入到业务代码中.只需要按照java-do ...
基于文档注释接口文档生成工具(代码0侵入附源码)
本文主要分享一个基于个人兴趣,旨在提高工作效率,开发了一个基于文档注释,接口文档生成工具,欢迎大佬指点. 源码以及使用demo地址 :传送门 1.前置介绍 1.1前世现在大多数项目都走向了前后端分离 ...
支持Dubbo接口文档生成的工具！
点击上方蓝色"程序猿DD",选择"设为星标" 回复"资源"获取独家整理的学习资料! 作者 | 肥朝来源 | https://mp.weix ...
转帖“接口测试工具和接口文档生成”
最近在研究接口测试,然后在网上找工具来进行接口测试.现在主流使用的接口测试工具一般有:jmeter.postman.soapui.apipost jmeter可以进行接口测试和性能测试,但是对于做单纯 ...

Swagger自动接口文档生成框架————springboot整合swagger总结