这是一个创建于 3779 天前的主题，其中的信息可能已经有所发展或是发生改变。
我是前台(Flash,iOS)目前是用markdown写导出html给PHP们看，列明每条接口的PHP名字，传入什么参数，返回什么内容之类。
大概是这样子的一个东西，http://coonlab.com/ahhapuzzle_api.html
虽说用起来不错，但觉得是不是有专门的工具去干这个事情的，你们跟后台定义接口的时候的文档是用什么工具写的？
（因为前台需求是主导，所以不可以用后台直接生成的那种接口文档，因为首先要告诉他们我需要返回什么样的数据，而不是他们自己去定返回什么给我）
大概是这样子的一个东西，http://coonlab.com/ahhapuzzle_api.html
虽说用起来不错，但觉得是不是有专门的工具去干这个事情的，你们跟后台定义接口的时候的文档是用什么工具写的？
（因为前台需求是主导，所以不可以用后台直接生成的那种接口文档，因为首先要告诉他们我需要返回什么样的数据，而不是他们自己去定返回什么给我）
 |
1
churchmice 2014-07-22 02:16:30 +08:00 via Android
有敏感词唉
|
 |
2
yellowV2ex OP @churchmice 哪里哪里
|
 |
3
jsq2627 2014-07-22 04:08:14 +08:00
|
 |
4
TangMonk 2014-07-22 08:23:22 +08:00
|
 |
5
zhouzm 2014-07-22 08:53:21 +08:00  1
|
 |
6
sxd 2014-07-22 09:22:46 +08:00
为什么是前台写文档给后台 接口不是后台定么?
|
 |
7
ijse 2014-07-22 09:42:23 +08:00
http://apiary.io/ 这个挺不错的，用的也是api blue print
|
|
8
yellowV2ex OP |
 |
9
Mutoo 2014-07-22 10:13:15 +08:00
vimeo已经被认证好多年了，真理部不喜欢这群搞艺术的，特别是有想法的搞艺术的。
|
 |
11
oa414 2014-07-22 10:31:04 +08:00
|
 |
12
lynnlee 2014-07-22 11:19:34 +08:00
我以为都用word呢
|
 |
13
erse 2014-07-22 12:07:10 +08:00
dokuwiki
|
 |
14
zouxcs 2014-07-22 16:17:45 +08:00
现在文档都走高端路线了，想当年写word文档到吐啊
|
 |
15
lidl 2014-10-23 11:58:21 +08:00
我需要本地编写api文档 ，并导出pdf或html
用什么 工具 ，求教。 |
|
16
yellowV2ex OP @lidl Markdown，写好了找个工具导出PDF或html，我现在就是
|
 |
17
errun 2014-11-14 15:41:21 +08:00
@yellowV2ex 我也是用markdown，但是现在感觉markdown还是比较适合用来写文章，用来写接口文档太累了，毕竟接口文档实际上有个基本的格式的，写接口文档的工具应该只用关心填写内容就好了，不必去关心格式。。
|
 |
18
pheyer 2015-02-16 16:13:26 +08:00
发现了一个好工具RAP，阿里内部使用的，也许对大家有用，介绍可以参考http://div.io/topic/642，接口自动化工具RAP的设计思路
宣传片：v.youku.com/v_show/id_XNjk5NjMxODA4.html 官网： http://thx.github.io/RAP/index_zh.html 源码： https://github.com/thx/RAP 入门视频：thx.github.io/RAP/study.html 部署RAP服务的文档： https://github.com/thx/RAP/wiki/deploy_manual_cn |
 |
19
zhishizhanghao21 2016-09-01 17:59:29 +08:00
小幺鸡，简单好用的在线接口文档管理系统
支持在线测试，经测试（可降低接口错误率）。 支持 json ， js ， websocket ，二进制测试。 支持 restful 接口。 |
|
20
zhishizhanghao21 2016-09-01 17:59:47 +08:00
|
|
21
jsq2627 2017-03-09 12:54:47 +08:00
穿越一下，回个老帖子。
最近正好在解决文档问题，做了 test2doc.js 这个文档生成工具，个人认为非常好用。 https://github.com/stackia/test2doc.js 使用案例：/t/346019 |
|
22
jsq2627 2017-03-09 12:55:10 +08:00
@jsq2627 #21 链接坏了。重发一下： https://www.v2ex.com/t/346019
|
 |
23
balabalaguguji 2019-01-22 22:13:36 +08:00
强烈推荐你 https://easydoc.xyz
|
|
24
balabalaguguji 2019-02-21 14:50:40 +08:00
@yellowV2ex 你这种编写接口文档太低效了，推荐你 easydoc.xyz ，体验无敌
|
Select Language