这里介绍如何生成好看的rest api文档,唯一不足的就是postman 中json不能加注释,但是可以通过其他地方加
工具/原料
postman
方法/步骤
1
rest风格api 主要四个 get 查询, post 添加 ,put 更新 ,del 删除,合理利用文件夹排版,可以很好打注释
2
发不api文档也很简单,直接要发布的文件夹后面省略号,点击public docs
3
但是要注意这个按钮是不是橙色,不是橙色,证明网络又问题
4
可以在网络里面设置下网络设置
6
点击文件夹后面的省略号,然后编辑edit,里面支持markdown,可以很好的表面这个文件里面字段的注释
7
在文档里面的效果就是这样,看着很舒服
8
这里也是支持markdown注释的,可以在这里添加Response,因为请求结果不会再文档展示
9
最后显示就如下,关于更新,只要那个符号是橙色的就是实时更新,只需刷新网页就可以了