将 ReadMe 接入 Open Flow

维护准确的指南,并为每次发布整理清晰说明。

每月 20,000 次免费应用调用(付费服务另计)

可以做什么

可查找与修改文档、查看版本和分类,并维护已连接项目的更新日志。

文档

搜索、读取、创建和修改文档页面。

项目结构

读取版本、类别、项目元数据与 OpenAPI 定义。

发布说明

读取、创建和修改更新日志。

所有工具

33 个工具

Get Project

获取与 API 密钥关联的 ReadMe 项目的元数据。

readme.get_project

List Versions

列出为 ReadMe 项目配置的版本。

readme.list_versions

Get Version

按 semver 标识符获取一个 ReadMe 项目版本。

readme.get_version

Create Version

从现有基础版本创建新的 ReadMe 项目版本。

readme.create_version

Update Version

按 semver 标识符更新一个 ReadMe 项目版本。

readme.update_version

Delete Version

按 semver 标识符删除一个 ReadMe 项目版本。

readme.delete_version

List Categories

列出 ReadMe 指南和参考类别,支持可选的版本和分页。

readme.list_categories

Create Category

创建 ReadMe 指南或参考类别。

readme.create_category

Get Category

按 slug 获取一个 ReadMe 类别。

readme.get_category

Update Category

按 slug 更新一个 ReadMe 类别。

readme.update_category

Delete Category

按 slug 删除一个 ReadMe 类别。

readme.delete_category

List Category Docs

列出属于某个类别 slug 的 ReadMe 文档。

readme.list_category_docs

Search Docs

按文本查询搜索 ReadMe 文档。

readme.search_docs

Create Doc

使用类别 ID 或类别别名创建 ReadMe 文档页面。

readme.create_doc

Get Doc

按别名获取一个 ReadMe 文档,可选择请求生产文档版本。

readme.get_doc

Update Doc

按别名更新一个 ReadMe 文档页面。

readme.update_doc

Delete Doc

按别名删除一个 ReadMe 文档页面。

readme.delete_doc

List Custom Pages

列出 ReadMe 自定义页面,支持可选分页。

readme.list_custom_pages

Create Custom Page

创建 ReadMe 自定义页面。

readme.create_custom_page

Get Custom Page

按别名获取一个 ReadMe 自定义页面。

readme.get_custom_page

Update Custom Page

按别名更新一个 ReadMe 自定义页面。

readme.update_custom_page

Delete Custom Page

按别名删除一个 ReadMe 自定义页面。

readme.delete_custom_page

List Changelogs

列出 ReadMe 变更日志条目,支持可选分页。

readme.list_changelogs

Create Changelog

创建 ReadMe 变更日志条目。

readme.create_changelog

Get Changelog

按别名获取一个 ReadMe 变更日志条目。

readme.get_changelog

Update Changelog

按别名更新一个 ReadMe 变更日志条目。

readme.update_changelog

Delete Changelog

按别名删除一个 ReadMe 变更日志条目。

readme.delete_changelog

List Api Specifications

列出 ReadMe API 规范元数据,支持可选版本和分页。

readme.list_api_specifications

Delete Api Specification

按 ID 删除一个 ReadMe API 规范。

readme.delete_api_specification

Get Api Registry

按 UUID 检索一个 ReadMe API Registry 条目。

readme.get_api_registry

Get Openapi Schema

获取 ReadMe 项目的 OpenAPI 定义。

readme.get_openapi_schema

List Outbound Ips

列出用于 Webhook 和 Try It 代理请求的 ReadMe 出站 IP 地址。

readme.list_outbound_ips

Ask Owlbot

向 ReadMe Owlbot 提出非流式问题,并返回带来源的答案。

readme.ask_owlbot

将 ReadMe 接入 Open Flow

连接 ReadMe

每月 20,000 次免费应用调用(付费服务另计)