postman 生成在线rest api 文档

2024-11-09 16:38:46

1、rest风格api 主要四个 get 溽朽孑臾查询, post 添加 ,put 更新 ,del 删除,合理利用文件夹排版,可以很好打注释

postman 生成在线rest api 文档

2、发不api文档也很简单,直接要发布的文件夹后面省略号,点击public docs

postman 生成在线rest api 文档

3、但是要注意这个按钮是不是橙色,不是橙色,证明网络又问题

postman 生成在线rest api 文档

4、可以在网络里面设置下网络设置

postman 生成在线rest api 文档postman 生成在线rest api 文档

5、然后直接就打开网页了,会生成一个连接打开就可以查看了

postman 生成在线rest api 文档postman 生成在线rest api 文档

6、点击文件夹后面的省略摒蛲照燔号,然后编辑edit,里面支持markdown,可以很好的表面这个文件里面字段的注释

postman 生成在线rest api 文档

7、在文档里面的效果就是这样,看着很舒服

postman 生成在线rest api 文档

8、这里也是支持markdown注释的,可以在这里添加Response,因为请求结果不会再文档展示

postman 生成在线rest api 文档postman 生成在线rest api 文档

9、最后显示就如下,关于更新,只要那个符号是橙色的就是实时更新,只需刷新网页就可以了

postman 生成在线rest api 文档
猜你喜欢