API
标签文章: API
API
减少支持工单的认证文档
围绕“减少支持工单的认证文档”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“减少支持工单的认证文档”，重点是可执行、可验证和可维护的做法。
2 分钟阅读
API
如何记录 API 错误，让开发者能够恢复
围绕“如何记录 API 错误，让开发者能够恢复”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“如何记录 API 错误，让开发者能够恢复”，重点是可执行、可验证和可维护的做法。
3 分钟阅读
API
如何正确编写 REST API 文档
好的 API 文档需要把机器可读契约、人类解释、可运行示例和明确的错误行为结合起来。 REST API 文档同时面向机器和人。机器可读契约描述 path、method、parameter、schema 与 response；人类文档解释意图、约束、工作流和开发者要做的选择。
2 分钟阅读
学习
通过构建一个小 API 学习 API 文档
围绕“通过构建一个小 API 学习 API 文档”给出可执行、可验证并且便于长期维护的技术写作方法。 从技术写作角度解释“通过构建一个小 API 学习 API 文档”，重点是可执行、可验证和可维护的做法。
2 分钟阅读
API
OpenAPI 是事实来源，但不是完整的 API 文档
OpenAPI 描述可以生成准确的 reference 结构，但开发者仍需要概念、任务流程、身份认证、示例和错误恢复，这些不是一个 schema 能单独解释的。 OpenAPI 非常擅长描述 operation、parameter、request/response 结构、status code 和可复用 schema。
2 分钟阅读