ReadMe
面向维护对外 API 文档团队的托管平台,支持导入 OpenAPI 生成可试调的参考页,并提供 AI 写作助手与 Ask AI 问答,适合接口迭代频繁、想让外部开发者自助上手的工程与 DevRel 团队。
2 次可以打开平均 1.4 秒
本站从国内机房定期实测。竖条由远及近:绿 = 可以打开,橙 = 国内不可直接访问,灰 = 打不开。ReadMe 是一个把 API 文档当产品来做的托管平台。团队把接口说明、指南、变更日志放上去,生成一个带品牌域名的文档站,开发者可以在里面直接试调接口、复制示例代码。它面向的是有对外 API 的公司,尤其是需要让文档跟上接口迭代速度的工程和 DevRel 团队。
主要功能
写作端提供所见即所得编辑器,支持 Markdown、MDX 和自定义组件,也能直接导入已有的 OpenAPI 文件生成 API 参考页。文档可以和 GitHub、GitHub Enterprise Server、GitLab 双向同步,在 ReadMe 里审阅、合并分支。平台还带版本管理、自定义主题、搜索和用量分析。
AI 相关的能力铺得比较开:编辑器里有写作助手 Agent,Linter 按风格指南检查措辞,Docs Audit 给文档打分,还有 AI 翻译和 Ask AI 问答。面向 AI 消费侧,它提供 LLMs.txt 和 MCP Server,让 AI 工具能读到文档内容。
费用与限制
Starter 免费,含 1 个项目、1 个版本、自定义域名和基础 AI 功能;Pro 每月 250 美元、按年计费,解锁多人协作、分支审阅、私有文档、变更日志和论坛等;Enterprise 需联系销售,按年计费,增加无限席位、SSO、审计日志和专属支持。Ask AI 在免费版和 Pro 版都是每月 150 美元的加购项,请求历史延长保留另收每月 100 美元。界面为英文,注册通过邮箱在网页端完成。
适合谁
接口数量多、文档需要频繁更新、又想让外部开发者自助上手的团队比较合适。如果只是写几页静态说明,免费版的项目数和版本数限制会很快碰到。