serge001
V2EX  ›  API

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

  •  
  •   serge001 · Dec 5, 2017 · 7325 views
    This topic created in 3104 days ago, the information mentioned may be changed or developed.

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

    Supplement 1  ·  Dec 7, 2017

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

    3 replies    2018-12-26 10:51:09 +08:00
    lizheming
        1
    lizheming  
       Dec 5, 2017
    我一直在用 http://apidocjs.com/ 感觉也还不错
    zthxxx
        2
    zthxxx  
       Dec 5, 2017
    docsify https://docsify.js.org/
    Docup https://github.com/egojump/docup

    这两个的作者都在 v 站
    balabalaguguji
        3
    balabalaguguji  
       Dec 26, 2018
    推荐你 https://easydoc.xyz 专为 api 文档定制的工具,肯定很适合你
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   3014 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 35ms · UTC 08:22 · PVG 16:22 · LAX 01:22 · JFK 04:22
    ♥ Do have faith in what you're doing.