(您可以在此处找到演示文稿的幻灯片。) 开发者体验是通用用户体验的延伸，它侧重于开发者及其使用您的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