网络研讨会回放:编写 RESTful API 文档

新闻 | Pieter Humphrey | 2015 年 2 月 10 日 | ...

演讲者:Andy Wilkinson

API 的文档对于使其易于理解和使用至关重要。 RESTful API 也不例外。 在本次网络研讨会中,我们将研究 RESTful API 文档中应包含的内容,以及同样重要的是,应省略的内容。 为了说明这一点,我们将看一些好的和坏的 API 文档的真实示例。 我们将研究选择像 Swagger 这样的工具来生成 API 文档的一些问题和局限性,最后研究一些更适合生成用户会喜欢的文档的替代方案。

了解更多关于 Spring MVC 的信息:http://projects.spring.io/spring-framework

了解更多关于 Spring REST Docs 的信息:https://github.com/wilkinsona/spring-restdocs

获取 Spring 新闻通讯

与 Spring 新闻通讯保持联系

订阅

抢先一步

VMware 提供培训和认证,以加速您的进步。

了解更多

获取支持

Tanzu Spring 在一个简单的订阅中提供对 OpenJDK™、Spring 和 Apache Tomcat® 的支持和二进制文件。

了解更多

即将到来的活动

查看 Spring 社区中所有即将到来的活动。

查看全部