如何写一份可复用的 API 文档

# 如何写一份可复用的 API 文档 API 文档应先给出最短成功路径，再补充认证、参数、错误、分页和限制。示例请求要能直接复制，响应字段需要说明类型、是否必填和典型取值。 遇到复杂接口时，可以用场景而不是字段列表组织内容：创建、查询、更新、失败重试和幂等处理，读者会更容易找到答案。