网络研讨会：RESTful API 文档

新闻 | Pieter Humphrey | 2015年1月20日 | ...

演讲者：Andy Wilkinson, Pivotal

API 的文档是使其易于理解和使用至关重要的一部分。RESTful API 也不例外。在本次网络研讨会中，我们将探讨 RESTful API 文档应包含的内容，以及同样重要的，应省略的内容。为了说明这一点，我们将通过一些真实世界的优秀和糟糕 API 文档示例进行分析。我们将探讨使用 Swagger 等工具生成 API 文档时存在的一些问题和局限性，并最终讨论一些更适合生成用户喜爱的文档的替代方案。