首页 > 其他分享 >接口文档编辑工具+接口文档编写

接口文档编辑工具+接口文档编写

时间:2022-12-26 17:08:32浏览次数:55  
标签:GET 接口 文档 https 编写 POST


目录

​​接口文档编辑工具​​

​​接口文档编写​​

​​补充​​

​​GET与POST的区别​​


接口文档编辑工具

参考​​@Lucky锦【接口文档编辑工具】​

Swagger:
通过固定格式的注释生成文档. 省时省力,不过有点学习成本。
​​​https://swagger.io/​

eoLinker
​​​https://www.eolinker.com/#/​

ShowDoc(我使用的是这个,制作的效果不错。里面也有一些接口文档示例,可以参考)
​​​https://www.showdoc.cc/​

初始界面 

接口文档编辑工具+接口文档编写_编辑工具

选项 

接口文档编辑工具+接口文档编写_接口文档_02

 

示例模板 

接口文档编辑工具+接口文档编写_工具_03

 

 

接口文档编写

参考​​@qq_41961113【正确规范写接口文档】​​,​​@东东427【接口文档应该如何编写】​​

 

补充

GET与POST的区别

​@大宽宽【GET 和 POST 到底有什么区别?】​

 

 

标签:GET,接口,文档,https,编写,POST
From: https://blog.51cto.com/u_15849465/5969416

相关文章