介绍
Swagger API框架,用于管理项目中API接口,属当前最流行的API接口管理工具。 Swagger功能强大,UI界面漂亮,支持在线测试等!
Swagger包括库、编辑器、代码生成器等很多部分,Swagger UI是一个API在线文档查看和测试的利器,Swagger Editor主要是编写api接口文档,但需要配合Swagger UI来展示,使用yaml编写。
国内开发者也有提供一整套开源的解决方案sosoapi,基于swagger的实现的,操作简单方便。可以导出swagger文件或者PostMan文件等。sosoapi是基于json文档的形式整合swagger,提供在线表单编辑对应的json格式文档及相关的一些团队协助功能,如团队成员管理,权限控制,导出html/word,编辑日志,复制项目/接口,mock服务。表单形式的编辑方式大大降低了集成swagger的学习成本,使得团队能快速上手。界面的展示也是使用原生的Swagger UI。
Swagger 环境搭建
1. Swagger
Swagger Editor
Swagger UI
Github主页 下载源码,将dist目录访放入http容器/web容器(如tomcat等)即可通过目录名“dist”访问。
2. SosoApi
Eclipse部署源码
到 sosoapi Github项目地址 下载项目(web和framwork),并将项目部署到Eclipse,修改部分pom,并将framwork里面的项目都分别导入到Eclipse,项目结构如图:
使用
1. Swagger
通过Swagger Editor编写基于YAML语法定义的RESTful API,然后它会自动生成一篇排版优美的API文档,并且提供实时预览。并且可以生产客户端和服务器的接口定义的代码。
编辑完,下载json文件“swagger.json”
将json文件导入Swagger UI中,在Swagger UI项目根目录下修改index.html文件
访问Swagger UI主页即可看到更新的api
Swagger 集成代码的用法
Swagger 可以和Spring MVC或Spring Boot 整合,通过注解自动生成Swagger 文档。
2. SosoApi
主要功能如下:
最终效果
点击“测试”效果
总结
如果使用Swagger的话使用sosoapi较为方便而且操作简单。
资料
本站仅提供存储服务,所有内容均由用户发布,如发现有害或侵权内容,请
点击举报。