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

最新推荐文章于 2023-12-10 15:36:25 发布
最新推荐文章于 2023-12-10 15:36:25 发布
阅读量3.7k 收藏 8
点赞数 2
分类专栏： 实用工具 文章标签： 接口文档 工具 编写规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41528502/article/details/104672716
版权

目录

接口文档编辑工具

接口文档编写

补充

GET与POST的区别

接口文档编辑工具

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

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

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

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

初始界面 

选项 

 

示例模板 

 

 

接口文档编写

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

 

补充

GET与POST的区别

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

 

 

&再见萤火虫&
关注
  • 2
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
notepad++文档编辑器
09-13
Notepad++是 Windows操作系统下的一套文本编辑器(软件版权许可证: GPL)，有完整的中文化接口及支持多国语言编写的功能(UTF8技术)。 Notepad++功能比 Windows 中的 Notepad(记事本)强大，除了可以用来制作一般的纯文字说明文件，也十分适合编写计算机程序代码。Notepad++ 不仅有语法高亮度显示，也有语法折叠功能，并且支持宏以及扩充基本功能的外挂模组。
markdown在线api接口编辑，像写代码一样的编写接口文档.zip
09-24
markdown在线api接口编辑，像写代码一样的编写接口文档.zip,showdoc是一个非常适合it团队在线共享文档的工具
大猿人中控充值，支持代理分销、API接口对接等功能系统源码
zhangjing5556的博客
07-15 1926
代理分销功能可以帮助用户建立自己的分销网络，实现产品的快速销售和收入的增加。这款系统源码的使用将大大提高充值服务的效率和用户体验，为企业和个人带来更多的商机和利润。未来，随着技术的不断发展，这类系统源码有望得到更多的创新和改进，以满足用户不断增长的需求。这种灵活的对接方式不仅提高了系统的整体效率，还使得用户可以选择更多的支付渠道和服务提供商，满足不同需求。首先，这个系统源码具备代理分销功能。这样，即使系统被检测到有潜在的安全风险，也能在很短的时间内完成更换，保证了系统的安全性和稳定性。
接口文档笔记
enthan809882的博客
04-04 593
请求描述 – – 请求地址 http://prd-domain.net/crm/api/findUser生产环境http://sit-domain.net/crm/api/findUser测试环境 请求方式 HTTP POST 入参类型 JSON 出参类型 JSON
大猿人中控充值系统源码/大猿人搭建教程/支持代理分销、API接口、公众号等功能
金闪闪呀
12-10 1912
服务器和域名准备好后，就可以操作了~ 总体上来讲，大猿人中控系统的搭建比较简单，相大猿人中控系统目前是市面上用的最多的电话费充值中控系统，支持代理分销、公众号H5、API接口对接等功能，也是目前最完善的一款中控系统。（保姆级大猿人中控系统源码搭建教程，大家可以参考学习）
全国电费充值优惠接口源码
weixin_47458273的博客
07-11 526
网关URL：https://router.wikeyun.cn/rest/Power/addCard参数名类型必填参数说明store_id字符串是店铺IDcard_num字符串是充值账号province字符串是省份,带省字，比如江苏省city字符串是城市,带市字，比如南京市remark 字符串否备注type整数否0国家电网 1南方电信网关URL：https://router.wikeyun.cn/rest/Power/editCard参数名类型必填参数说明card_id字符串是卡ID
api文档
LOVESD
09-14 190
ShowDochttps://www.showdoc.com.cn/help/16118
接口文档修改问题分析
无
05-31 459
问题价值： 1.在实际中，经常出现接口本身的增删改查，参数的修改和添加删除，返回值的变化和修改； 2.前后端分离，接口文档是一种非常重要的前后端人员沟通的媒介 ，但是接口文档又具有版本时效性的特点； 3.公司人员的流入流出，新人对项目接口的理解需要借助尽可能的接口文档，特别是对参数的description, 不然一种领域的系统，可能因为对领域参数的不了解，造成对效率的影响 技术选型分析： 1.swagger 的问题就是注解太多，导致项目代码耦合了太多接口文档相关代码，但是和springboot适配性好 2.
ShowDoc简明教程
MELF晓宇的博客
08-10 3488
ShowDoc提供免费开源的版本，你可以选择将ShowDoc部署到你的服务器。 ShowDoc的安装 使用自动脚本安装： #下载脚本并赋予权限 wget https://www.showdoc.cc/script/showdoc;chmod +x showdoc; #默认安装中文版。如果想安装英文版，请加上en参数，如 ./showdoc en ./showdoc 你可以打开 http://xxx.com:4999 来访问showdoc (xxx.com为你的服务器域名或者IP)。 账户密码是showd
Linux系统之安装showdoc文档工具
jks212454的博客
06-22 3415
Linux系统之安装showdoc文档工具
Show-Doc让你能在公司装一波的接口文档搭建全流程
纯洁的微笑
07-14 537
大家还记得之前阿粉给大家推荐的一个写接口文档的神器么？Run-API，前段时间，因为 Show-Doc 进行网站升级，忽然的一天早上 Run-API 失效了，这下整的阿粉就有崩溃了，啥情况...
正文编辑WPS开发文档及DEMO
06-02
WPS Android专业版加解密是指WPS连接用户自己编写的加密工具，使用加密工具对数据进行加解密，加解密算法是有用户自定义的，用户只需要实现连接WPS的接口就可以对WPS打开文件的数据进行加解密控制，从而提高数据的...
Notepad++7.3.3
12-03
Notepad++是 Windows操作系统下的一套文本编辑器(软件版权许可证: GPL)，有完整的中文化接口及支持多国语言编写的功能(UTF8技术)。
Java开发工具，自动生成api文档.zip
最新发布
03-07
文档编写与API管理： 文档生成工具可以自动生成代码注释文档，便于团队内外理解和使用项目代码。 API管理工具则方便开发者创建、测试、发布和维护API接口。 持续集成与持续部署（CI/CD）： Jenkins、Travis CI...
Windows配置ThingsBoard，并实现简单Demo（未完待续）
&再见萤火虫&的博客
03-24 2984
坑已经被我踩过一遍了
Windows向Ubuntu拷贝文件，用 scp 命令提示：Permission denied, please try again. 的解决办法
&再见萤火虫&的博客
11-19 2010
全文主要内容来自@乔少年【Ubuntu 14.04.4 下 scp 远程拷贝提示：Permission denied, please try again. 的解决办法】。 这里添加部分实际运行截图及部分问题解决方法 我在 s0 主机上远程拷贝 /etc/hosts 文件到 s1 主机上，出现下面的错误提示： qiao@s0:~$ scp /etc/hosts root@s2:/etc/ root@s2's password: Permission denied, please try aga.
Windows中使用Java执行shell命令运行检测，通过sonarqube的webapi获取扫描结果
&再见萤火虫&的博客
02-19 1785
具体安装配置过程教程比较多，这里就不再详细介绍了。 1，在官网下载sonarqube和sonar-scanner后，解压、修改配置（主要是连接数据库）； 2，在sonarqube的bin目录下运行StartSonar.bat后，可以看到证明启动成功了； 3，浏览器地址栏输入localhost:9000就能进入sonarqube登录界面，账号密码默认都是admin； 4，执行代码扫描的功能主要通过sonar-scanner进行，通常的扫描方法是在sonar-scanner/conf下，编辑so...
Eclipse web项目转idea项目问题整理（包括tomcat配置，404，500错误等）
&再见萤火虫&的博客
11-22 1226
目录 1，如何将eclipse项目导入到idea 2，导入项目后，导航栏内容消失？ 3，IntelliJ IDEA配置一个web项目找不到tomcat 4，Error running 'Tomcat8.5': port out of range:-1 5，Error running ‘Tomcat 8.5.57‘: Address localhost:8080 is already in use报错 6，Idea导入eclipse web项目404问题（webcontent） 7，服务器内部错
编写android接口文档工具
08-06
编写Android接口文档工具主要是为了方便开发人员在开发过程中对接口进行管理和文档化。以下是一种可行的方式： 首先，我们需要设计一个界面友好且功能完善的工具。该工具可以接收用户输入的接口信息，如接口名称、...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值