想找款在线记录api接口文档的网站,然后看了一下这些站点的免费和收费的区别,以及他们的功能。
大致测试了一下:
看云
看云可以帮你轻松完成包括帮助文档、知识库、项目文档、API文档(支持在线调试)以及电子书籍(支持打赏及付费阅读)在内的所有文档管理。
示例链接:
https://www.kancloud.cn/shuai/api_demo/67274
https://www.kancloud.cn/manual/thinkphp5/135176
API文档
看云独有格式,让你快速定义和生成API文档,并支持在线调试,移动APP接口开发的必须。
效果不错,就是书写格式独特了些
ShowDoc
示例链接:
https://www.showdoc.com.cn/demo?page_id=9
这个效果也不错,简单容易操作,免费版满足我的需求了,是我的首选
语雀
示例链接:
https://www.yuque.com/yuque/developer/high_level_api
个人感觉合适做图文记录,记录代码还是可以的,对于api接口的格式记录不是很友好。
易文档
官方介绍:
快速编写接口文档
API文档、需求文档、使用手册,多种定制编辑器,让您轻松编写和维护高质量的文档; 支持接口在线测试,一键生成文档、调用示例、mock配置。 极致的编写体验,优雅的排版,让文档成为一种乐趣。
示例链接:
https://easydoc.xyz/s/17790664/CZMqMhfW/78558034
https://easydoc.xyz/doc/25791054/uw2FUUiw/osolGpJE
api接口记录格式还不错