skyshy
V2EX  ›  问与答

API 接口文档,大家是用什么写的?并能简便文档?

  •  
  •   skyshy · Mar 11, 2018 · 2737 views
    This topic created in 3029 days ago, the information mentioned may be changed or developed.
    • 过去的方式:服务端提供 API 接口,一开始商定是写在 wiki 上的,有参数说明,返回结果的例子。当然有一些通用的,比如返回状态码、通用参数等等。

    • 目前情况: 已经合作大约一年了,因为现在业务线比较多,然后直接告诉我不想写 wiki 文档了,目前状况人员稀缺、业务多,加上 wiki 写文档比较慢不好编辑,影响他开发进程,已来不及写了,给我一个诸如 postman 之类的让我先用用。

    对于我而言:文档说明不能没有的,是我和其他人唯一参考的标准,不管怎么样,为了加快进程,开发过程中是可以有临时的其他方式,但文档一定要补上,以后排查问题总得有文档可以查阅吧。

    来这里就想问问大家:

    • 类似这样的合作上大家有什么比较高效的方式,或者有推荐的方案?
    • 另外,API 文档用什么写比较快捷呢?
    5 replies    2019-04-19 17:02:51 +08:00
    klren0312
        1
    klren0312  
       Mar 11, 2018
    swagger
    azygote
        2
    azygote  
       Mar 11, 2018
    swagger + 1
    darkgeek
        3
    darkgeek  
       Mar 11, 2018 via Android
    我用 apidoc,使用简单,对代码无侵入。
    CoderGeek
        4
    CoderGeek  
       Mar 11, 2018 via iPhone
    之前用 swagger 现在我用的 markdown 会不会很搞 哈哈
    balabalaguguji
        5
    balabalaguguji  
       Apr 19, 2019
    强烈推荐 [易文档]( https://easydoc.xyz),专为开发人员准备的文档平台
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Solana   ·   1523 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 36ms · UTC 16:33 · PVG 00:33 · LAX 09:33 · JFK 12:33
    ♥ Do have faith in what you're doing.