Swagger 是一个规范且完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务
Swagger 的目标是对 REST API 定义一个标准且和语言无关的接口,可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义,用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似,Swagger 消除了调用服务时可能会有的猜测
Swagger 的优势
支持 API 自动生成同步的在线文档:使用 Swagger 后可以直接通过代码生成文档,不再需要自己手动编写接口文档了,对程序员来说非常方便,可以节约写文档的时间去学习新技术
提供 Web 页面在线测试 API:光有文档还不够,Swagger 生成的文档还支持在线测试。参数和格式都定好了,直接在界面上输入参数对应的值即可在线测试接口
现有项目使用的是spring框架 现需要集成Swagger,步骤如下:
1.添加依赖
2.创建 Swagger 配置类
3.在spring.xml 增加扫描配置
4.后续就可以在controller和entity中 增加注解生成API文档
5.在配置文件中配置开关:swagger.enabled=true 测试环境打开 生产环境关闭
就可以启动项目 访问:http://localhost:8080/项目名/swagger-ui.html 查看api
Original: https://www.cnblogs.com/qinxu/p/14676604.html
Author: 【cosmo】
Title: Spring 集成 Swagger
原创文章受到原创版权保护。转载请注明出处:https://www.johngo689.com/540807/
转载文章受原作者版权保护。转载请注明原作者出处!