Swagger Editor是一款可以用yaml格式进行RESTful API设计、可视化、测试的工具,并且能够实时看到自动生成的文档。效果大概是这样的↓
根据官方网站介绍,如果是团队的话,建议用在线的SwaggerHub(似乎是有很多便于开发的套件);个人solo开发则建议下载本地的Swagger Editor。
因为不熟悉Node.js,所以简单记录一下安装流程:
1、首先需要安装Node.js的尽可能新的版本,这个时候npm也会一起配套安装好。直接去官方网站下载就行了。
2、来到Swagger Editor的github页面把压缩包下载到本地(或者clone)
3、解压到文件夹,这个时候可以看到有个index.html文件,直接点开就能用了,并且编辑之后直接关闭也不会丢失数据(保存在浏览器的本地存储中)
另外一种方法是启动静态服务器来打开编辑器,这需要做一些额外工作:
1、运行命令:npm install -g http-server (安装一个类似web容器的东西)
2、用安装好的工具启动静态服务器访问Swagger Editor。命令行切换到含有index.html的那个目录下,运行命令:http-server -p 端口号,
之后就可以在浏览器中访问Swagger Editor啦↓
PS. 在用于测试时,响应要允许跨域才能在浏览器正确显示。