springboot配置swagger(丝袜哥)生成api接口文档
前后端分离开发模式中,api文档是最好的沟通方式。
Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。
及时性 (接口变更后,能够及时准确地通知相关前后端开发人员)
规范性 (并且保证接口的规范性,如接口的地址,请求方式,参数及响应格式和错误信息)
一致性 (接口信息一致,不会出现因开发人员拿到的文档版本不一致,而出现分歧)
可测性 (直接在接口文档上进行测试,以方便理解业务)
配置Swagger2
第一步导入依赖
<!--swagger--><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><scope>provided </scope></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><scope>provided </scope></dependency>
第二步创建swagger的配置类
@EnableSwagger2不要忘记
@EnableSwagger2不要忘记
@EnableSwagger2不要忘记
重要事情说三遍
代码基本不用改,直接复制食用即可
@Configuration//配置类注解不要忘记
@EnableSwagger2
public class SwaggerConfig {@Beanpublic Docket webApiConfig(){return new Docket(DocumentationType.SWAGGER_2).groupName("webApi").apiInfo(webApiInfo()).select().paths(Predicates.not(PathSelectors.regex("/admin/.*"))).paths(Predicates.not(PathSelectors.regex("/error.*"))).build();}private ApiInfo webApiInfo(){return new ApiInfoBuilder().title("网站-课程中心API文档").description("本文档描述了课程中心微服务接口定义").version("1.0").contact(new Contact("Helen", "http://atguigu.com", "55317332@qq.com")).build();}
}
第三步重启项目并访问
http://localhost:8001/swagger-ui.html
注意自己的项目信息及端口号自行修改
四、接口文档显示出来
springboot配置swagger(丝袜哥)生成api接口文档相关推荐
- Laravel使用swagger PHP生成api接口文档
Laravel使用swagger PHP生成api接口文档 Swagger集接口文档和测试于一体,就类比将postman和showdoc的结合体 首先要先安装基于laravel5的swagger包 地 ...
- 如何自动生成 API 接口文档 - 一份详细指南
本篇文章详细教你如何使用 Apifox 的 IDEA 插件实现自动生成接口代码.好处简单总结有以下几点: 自动生成接口文档: 不用手写,一键点击就可以自动生成文档,当有更新时,点击一下就可以自动同步接 ...
- python生成api文档_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- python api接口生成_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
- Laravel使用Apidoc注解自动生成Api接口文档
本教程从零开始搭建laravel项目,并安装Apidoc扩展及使用注解生成Api接口文档的教程,该扩展支持 多应用/版本.Markdown文档.在线接口调试.接口生成器.代码模板生成器.Mock调试数 ...
- 开发日记-20190328 关键词 利用eolinker一键快速生成API接口文档
今天感觉效率真的很低= =各个层面的,apk发布到现场发现出现了问题,所以一个下午都在忙着解决现场出现的问题,领导一直打电话询问进度,午觉也没有睡所以今天预计的很多计划都处于停滞状态,像昨天规划的今天 ...
- apidoc 自动化生成 api接口文档
手写api接口太麻烦. 学习了apidoc自动生成接口文档,这边做一下整理 要用组件那就必须先安装 apidoc,做一下全局安装 npm install apidoc -g 新建配置文件apidoc. ...
- Swagger+Spring mvc生成Restful接口文档
2019独角兽企业重金招聘Python工程师标准>>> Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务.总体目标是使客户端 ...
- springboot(05)整合 Swagger3 生成 API 接口文档
Spring Boot 集成 Swagger3 Swagger是一种开源的API文档工具,它可以自动生成RESTful API文档,让开发者可以更容易地理解和使用API.使用Swagger可以提高开发 ...
- 项目配置Swagger2生成API接口文档
一.Swagger2介绍 前后端分离开发模式中,api文档是最好的沟通方式. Swagger 是一个规范和完整的框架,用于生成.描述.调用和可视化 RESTful 风格的 Web 服务. 及时性 (接 ...
最新文章
- python programming training(三):搜索算法
- linux网络相关常见问题
- js md5加密脚本
- HDU - 2050 折线分割平面(规律题)
- java+spring+mysql配置_JAVA后台搭建(springboot+mybatis+mysql)项目搭建
- 读取Webpage表中的内容
- java strcpy,详解C语言中strcpy()函数与strncpy()函数的使用
- putty远程登录ssh主机
- [CSS3] touch-action设置移动端拖动行为
- oracle 10g for linux
- python 绘图sns.distplot
- win10无法装载iso文件_win10系统解决方案无法打开iso文件
- 怎么转换kux格式?教你把优酷的kux格式转换成avi
- linux 局域网传文件,利用ssh在linux系统之间在局域网内传输文件
- 计算机绘图综合训练大题,工程制图与计算机绘图综合实训报告汇编.doc
- 美团项目 ---首页开发2
- 烟沙浮生 | 曾几何时,还是游吟长安的醉客 1
- 2020年有寓意的领证日期_2020领证吉日
- Redis五大数据类型常用命令
- 小红书笔记api_小红书笔记怎么写?
热门文章
- 应该了解的数据库系统高性能利器-WAL
- 【backtrader与IB(盈透证券)实盘交易教程4】使用resample合成多周期数据的时候需要注意的一些问题
- 518抽奖软件,支持PPT激光翻页笔远距离控制抽奖
- 新颖的计算机比赛,荣誉之战!“中国高校计算机大赛—人工智能创意赛”获奖名单出炉...
- YOLO系列:V1,V2,V3,V4简介
- JFreeChart 多饼图乱码和iText转PDF乱码问题
- Plugin org.apache.maven.plugins:maven-clean-plugin:2.6.1 or one of its dependencies could not be res
- LeetCode10-正则表达式匹配
- CS231n Lecture 16 | Adversarial Examples and Adversarial Training
- Python在Windows下操作CH341DLL