（您可以在这里找到演示文稿的幻灯片。）开发者体验是通用用户体验的延伸，它强调开发者及其使用您的 API 的体验。良好的 API 开发者体验不仅仅是技术写作。它还包括提供所有正确的资源，以帮助您的最终用户成功集成和使用您的 API。
文档在 DX 中的作用
精心设计的开发者体验以 API 文档为中心。 API 文档是成功使用和集成 API 所需的信息。这可以是技术写作、代码示例和范例的形式，以便更好地理解如何使用 API。 根据 SmartBear 2016 年的 API 状态报告，现在有 75% 的开发 API 的组织拥有正式的文档流程。46% 的人认为这对他们的组织来说是高度优先事项。 简洁明了的文档（允许您的 API 用户快速将其集成到他们的应用程序中）对于希望推动 API 采用的组织来说不再是可选的。
良好的文档并非易事
对于许多 API 团队来说，文档仍然是一项繁琐且耗时的任务。对于那些依赖于静态文档并在每次发布新版本的 API 时手动更新文档的团队来说，尤其如此。 但是，组织记录其 API 的方式也发生了一些重大变化。这些变化最明显地体现在 API 描述格式（如 Swagger）的广泛采用上。 Swagger 是一个开源 API 框架，允许开发人员和团队设计、构建、记录和使用 RESTful Web 服务。Swagger 框架获得如此广泛采用的最大原因之一是能够生成交互式文档。此文档允许任何人（无论是您的开发团队还是您的最终用户）可视化 API 的资源并与之交互，而无需任何实现逻辑。 这种自动生成的文档是您的开发团队可以自定义并在此基础上构建的中心资源，从而为使用您的 API 创建更全面的用户手册。
将 Swagger 添加到您的文档中
无论您是 Swagger 的新手，还是已经使用该框架进行 API 设计，您仍然很可能对如何改进 API 文档有疑问。创建您的用户会喜欢的 API 文档可能需要一些工作，但是，这项投资将以出色的开发者体验、更简单的实施以及改进的 API 采用的形式获得巨大的回报。 本月，我们举办了一个关于 API 文档的免费培训，API 开发者体验：为什么重要，以及如何使用 Swagger 文档化您的 API 来提供帮助。 我们详细介绍了良好的开发者体验，重点介绍了为什么以及如何为使用您的 API 的开发人员提供最佳体验。我们还将介绍 Swagger 如何改变了 API 设计和文档格局，最后展示在 SwaggerHub 的集成 API 开发平台中使用 Swagger 进行 API 文档的一些良好实践。 本次网络研讨会的内容包括：
- 什么是开发者体验 (DX)？
- API 具有良好的 DX 意味着什么？
- 在良好 DX 的背景下，API 文档是什么？
- Swagger 框架简介
- 使用 Swagger 和 SwaggerHub 从可用性角度设计 API