V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
serge001
V2EX  ›  API

请问有哪些编写 api 文档的工具推荐?

  •  
  •   serge001 · 2017-12-05 21:44:27 +08:00 · 6564 次点击
    这是一个创建于 2305 天前的主题,其中的信息可能已经有所发展或是发生改变。

    需要和后端共同约定一套 api,所以需要我来编写 api 文档,看了很多目前最流行的 swagger 的文档,不是很懂,我需要的只是编写 api 文档,并不需要 mock 和测试之类,感觉用 swagger 好复杂的样子.找了很久发现阿里的 rap 的 1.0 版本(不是 2.0)比较符合我的需求,但是很无语的一点是定义的参数列表是按照首字母排序的,好不爽.请问还有比较好用的 api 文档编写工具推荐吗?或者说这种情况下 swagger 适合我的需求吗?

    第 1 条附言  ·  2017-12-07 09:44:13 +08:00

    多谢各位的推荐,目前在用sosoapi,基于swagger,不用再用YAML或者JSON语法来敲代码了,非常简单易上手,推荐有需要的可以试一下

    3 条回复    2018-12-26 10:51:09 +08:00
    lizheming
        1
    lizheming  
       2017-12-05 22:02:23 +08:00
    我一直在用 http://apidocjs.com/ 感觉也还不错
    zthxxx
        2
    zthxxx  
       2017-12-05 23:52:08 +08:00
    docsify https://docsify.js.org/
    Docup https://github.com/egojump/docup

    这两个的作者都在 v 站
    balabalaguguji
        3
    balabalaguguji  
       2018-12-26 10:51:09 +08:00
    推荐你 https://easydoc.xyz 专为 api 文档定制的工具,肯定很适合你
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   我们的愿景   ·   实用小工具   ·   5358 人在线   最高记录 6543   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 28ms · UTC 05:50 · PVG 13:50 · LAX 22:50 · JFK 01:50
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.