十大API文档模板

您是否需要为 RESTful API 创建API文档?想要自动生成 API 文档?今天，我将分享一些旨在展示您的 API 的免费模板。好的文档真的很 重要，所以从一个好的基础开始。这些 API 资源简单、干净、利用最佳实践，会让您的 API 用户满意。

1.Slate – 帮助您创建漂亮的 API 文档。它具有响应性，使用 Markdown 和 Ruby，其灵感来自Stripe和Paypal 的API 文档。这是一个演示。

2.apiDoc – 根据源代码中的 API 注释创建的 RESTful Web API 的内联文档。主题是 2 列，这里是一个演示。

3.FlatDoc - 使编写文档变得容易。没有构建过程，只有一个小的 JavaScript 文件，它可以获取 Markdown 文件并将它们呈现为完整页面。您可以从自述文件创建文档。默认主题是响应式的，您可以通过 Github Pages 进行部署。

4.Webservice API 规范文档模板——简单、简单、干净的 API 文档模板，构建为 Google Doc 页面。

5.API 蓝图——为您的整个 API 生命周期提供很棒的工具。您可以使用此工具自动生成文档等等。下面是一些例子。此外，请查看API 蓝图渲染器aglio。

6.Swagger – 简单而强大的 API 接口。大量自动化、API 工具，甚至客户端 SDK 生成和可发现性。查看现场演示。

7.Calamum – 从 JSON文件生成 REST API 文档。它有一个 twitter 模板和一个 bootstrap 模板。

8.miredot是一个用于 Java 的 REST API 文档生成器。查看示例。

9.RAML – 描述 RESTful API 的简单而简洁的方式。它建立在广泛使用的标准上，例如 YAML 和 JSON，并且它有许多工具，其中之一是RAML to HTML，它基于 RAML 文件输出文档。

10.RestDoc – PHP 脚本，用于从 YAML 文件生成 REST 文档。