大家前后端的接口文档一般用什么写？

2014-07-22 01:07:45 +08:00
 yellowV2ex
我是前台(Flash,iOS)目前是用markdown写导出html给PHP们看，列明每条接口的PHP名字，传入什么参数，返回什么内容之类。
大概是这样子的一个东西，http://coonlab.com/ahhapuzzle_api.html

虽说用起来不错，但觉得是不是有专门的工具去干这个事情的，你们跟后台定义接口的时候的文档是用什么工具写的？
（因为前台需求是主导，所以不可以用后台直接生成的那种接口文档，因为首先要告诉他们我需要返回什么样的数据，而不是他们自己去定返回什么给我）
29497 次点击
所在节点    程序员
24 条回复
jsq2627
2017-03-09 12:54:47 +08:00
穿越一下，回个老帖子。

最近正好在解决文档问题，做了 test2doc.js 这个文档生成工具，个人认为非常好用。

https://github.com/stackia/test2doc.js

使用案例：/t/346019
jsq2627
2017-03-09 12:55:10 +08:00
@jsq2627 #21 链接坏了。重发一下： https://tanronggui.xyz/t/346019
balabalaguguji
2019-01-22 22:13:36 +08:00
强烈推荐你 https://easydoc.xyz
balabalaguguji
2019-02-21 14:50:40 +08:00
@yellowV2ex 你这种编写接口文档太低效了，推荐你 easydoc.xyz ，体验无敌

这是一个专为移动设备优化的页面（即为了让你能够在 Google 搜索结果里秒开这个页面），如果你希望参与 V2EX 社区的讨论，你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://tanronggui.xyz/t/123829

V2EX 是创意工作者们的社区，是一个分享自己正在做的有趣事物、交流想法，可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX