Readme

Readme 是一个平台，允许您为您的 API 创建和发布互动式开发者文档。与传统的文档工具不同，Readme 会自动从您的 OpenAPI 或 Swagger 文件生成 API 参考文档，并保持与您的代码同步。

该平台内置编辑器，您可以在其中编写指南、添加代码示例，并解释您的 API 如何工作。使用您 API 的开发者可以通过“试一试”功能直接从文档中测试端点，使理解整个流程更加容易。

Readme 还提供分析功能，让您了解文档中哪些部分浏览量最高，以及开发者可能遇到的难点，帮助您随着时间推移不断改进 API 体验。

开始使用 Readme 简单明了。主要步骤如下：

• 在 Readme 网站注册一个免费账户，并创建您的第一个项目，设置自定义名称和 URL。

• 连接您的 OpenAPI 或 Swagger 文件，自动生成 API 参考文档，或使用手动编辑器逐个记录端点。

• 使用 Markdown 编辑器创建指南、教程和帮助文章。您可以添加代码块、图片和视频，使内容更有帮助。

• 通过选择主题、颜色并添加公司标志，定制文档外观以匹配您的品牌。

• 设置身份验证，使开发者能够使用自己的 API 密钥直接从文档中测试您的 API。

• 发布文档并将链接分享给您的开发者社区。

• 通过内置的分析仪表盘监控开发者如何使用您的文档，查看热门页面和常见问题。

• 带有“试一试”功能的交互式API参考

• OpenAPI和Swagger文件同步

• 用于指南和教程的Markdown编辑器

• 多版本API管理

• 自定义域名和白标品牌

• 实时分析和使用跟踪

• 团队协作，支持评审和分支

• 更新日志和讨论论坛

• 单点登录和高级安全

• AI驱动的文档工具

• 移动响应式设计