• 请不要在回答技术问题时复制粘贴 AI 生成的内容
yellowV2ex
V2EX  ›  程序员

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

  •  
  •   yellowV2ex · Jul 22, 2014 · 30499 views
    This topic created in 4331 days ago, the information mentioned may be changed or developed.
    我是前台(Flash,iOS)目前是用markdown写导出html给PHP们看,列明每条接口的PHP名字,传入什么参数,返回什么内容之类。
    大概是这样子的一个东西,http://coonlab.com/ahhapuzzle_api.html

    虽说用起来不错,但觉得是不是有专门的工具去干这个事情的,你们跟后台定义接口的时候的文档是用什么工具写的?
    (因为前台需求是主导,所以不可以用后台直接生成的那种接口文档,因为首先要告诉他们我需要返回什么样的数据,而不是他们自己去定返回什么给我)
    24 replies    2019-02-21 14:50:40 +08:00
    churchmice
        1
    churchmice  
       Jul 22, 2014 via Android
    有敏感词唉
    yellowV2ex
        2
    yellowV2ex  
    OP
       Jul 22, 2014
    @churchmice 哪里哪里
    jsq2627
        3
    jsq2627  
       Jul 22, 2014
    TangMonk
        4
    TangMonk  
       Jul 22, 2014
    http://apiblueprint.org/

    楼主不如看下这个,
    zhouzm
        5
    zhouzm  
       Jul 22, 2014   ❤️ 1
    写文档推荐 sphinx(sphinx-doc.org),开源项目可以用 readthedocs.org 托管文档。

    如果是内部开发,也可以自建 readthedocs 服务器 + git/svn
    sxd
        6
    sxd  
       Jul 22, 2014
    为什么是前台写文档给后台 接口不是后台定么?
    ijse
        7
    ijse  
       Jul 22, 2014
    http://apiary.io/ 这个挺不错的,用的也是api blue print
    yellowV2ex
        8
    yellowV2ex  
    OP
       Jul 22, 2014
    @sxd 先出的设计,然后前台就按照设计做,根据设计的字段定义需要的接口内容,所以前台是主导,要是后台去写的话,后台还要去研究设计和页面跳转什么的,比较麻烦。

    @TangMonk @zhouzm @ijse 谢谢推荐,我去试试看
    @jsq2627
    Mutoo
        9
    Mutoo  
       Jul 22, 2014
    vimeo已经被认证好多年了,真理部不喜欢这群搞艺术的,特别是有想法的搞艺术的。
    Mutoo
        10
    Mutoo  
       Jul 22, 2014
    @Mutoo 不好意思,穿越帖子了
    oa414
        11
    oa414  
       Jul 22, 2014
    LZ试试这个东西, https://helloreverb.com/developers/swagger

    根据代码和注释自动生成文档,还可以在线调试。。
    lynnlee
        12
    lynnlee  
       Jul 22, 2014
    我以为都用word呢
    erse
        13
    erse  
       Jul 22, 2014
    dokuwiki
    zouxcs
        14
    zouxcs  
       Jul 22, 2014
    现在文档都走高端路线了,想当年写word文档到吐啊
    lidl
        15
    lidl  
       Oct 23, 2014
    我需要本地编写api文档 ,并导出pdf或html
    用什么 工具 ,求教。
    yellowV2ex
        16
    yellowV2ex  
    OP
       Oct 23, 2014
    @lidl Markdown,写好了找个工具导出PDF或html,我现在就是
    errun
        17
    errun  
       Nov 14, 2014
    @yellowV2ex 我也是用markdown,但是现在感觉markdown还是比较适合用来写文章,用来写接口文档太累了,毕竟接口文档实际上有个基本的格式的,写接口文档的工具应该只用关心填写内容就好了,不必去关心格式。。
    pheyer
        18
    pheyer  
       Feb 16, 2015
    发现了一个好工具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
    zhishizhanghao21
        19
    zhishizhanghao21  
       Sep 1, 2016
    小幺鸡,简单好用的在线接口文档管理系统
    支持在线测试,经测试(可降低接口错误率)。
    支持 json , js , websocket ,二进制测试。
    支持 restful 接口。
    jsq2627
        21
    jsq2627  
       Mar 9, 2017
    穿越一下,回个老帖子。

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

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

    使用案例:/t/346019
    jsq2627
        22
    jsq2627  
       Mar 9, 2017
    @jsq2627 #21 链接坏了。重发一下: https://www.v2ex.com/t/346019
    balabalaguguji
        23
    balabalaguguji  
       Jan 22, 2019
    强烈推荐你 https://easydoc.xyz
    balabalaguguji
        24
    balabalaguguji  
       Feb 21, 2019
    @yellowV2ex 你这种编写接口文档太低效了,推荐你 easydoc.xyz ,体验无敌
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   2683 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 79ms · UTC 05:39 · PVG 13:39 · LAX 22:39 · JFK 01:39
    ♥ Do have faith in what you're doing.