如何写API接口文档

如果你是后台API开发人员,往往会为了写清晰的API接口文档而发愁 此处,自己的建议和经验是:

  • 方法1: 用markdown写API文档
  • 方法2: 用Postman生成API文档
  • 方法3: 用Swagger写(设计API接口的同时就可以生成出)API文档
    • 并可生成对应的后台和前端的代码
    • 剩下只需要编写业务逻辑代码即可

后来发现其他还有一些API文档工具,比如:

下面详细介绍这些写API文档的不同方法。

results matching ""

    No results matching ""