REST API ================= 你可以用Sphinx来手写API文档,但更加推荐使用支持OpenAPI规范的专门的REST API工具,比如国内阿里的rap和开源的Swagger。 Swagger有以下几点好处: * Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。 * Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。 * Swagger 文件可以在许多不同的平台上从代码注释中自动生成。 * Swagger 有一个强大的社区,里面有许多强悍的贡献者。 这里是一个详细的REST API文档编写教程:http://idratherbewriting.com/learnapidoc/