LogoLogo
Book a demoLog inStart for free
  • 入门
    • 概览
    • 工作原理
    • 快速开始
    • 项目结构
    • Customer showcase
    • Changelog
  • 配置
    • 概览
    • 站点级设置
    • 页面级设置
      • 版本
      • 章节、页面与文件夹
      • 标签页与标签变体
      • 版本
      • 产品
      • 更新日志页面
  • 编写内容
    • Markdown 基础
    • Markdown 中的富媒体
      • 概览
      • 折叠面板
      • 旁注
      • 按钮
      • 徽章
      • 下载
      • 提示框
      • 卡片
      • 代码块
      • 复制组件
      • 下载组件
      • 端点请求片段
      • 端点响应片段
      • 端点模式代码片段
      • Webhook 负载片段
      • 文件
      • 框架
      • 图标
      • If
      • 缩进
      • 参数字段
      • 提示词组件
      • Runnable endpoint
      • 模式组件
      • 步骤
      • 表格
      • 标签页
      • 工具提示
      • 版本
    • Fern 编辑器
    • 可复用代码片段
  • AI 功能
    • 概览
    • Fern Writer
    • AI 生成的示例
    • Markdown 访问
      • 概览
      • Agent 指令
      • 智能体指令
      • 分析与集成
    • MCP 服务器
    • API 目录发现
      • fern-docs 技能
      • 自定义技能
      • 概览
        • Slack 应用
        • 自定义指引
        • 额外内容来源
        • 独立搜索小部件
        • 简介
          • POSTPost Chat Completion
          • POSTCreate Code Record
          • POSTBatch Create Code Records
          • GETGet Code Record By Id
          • GETGet Code Records
          • DELDelete Code Record By Id
          • DELDelete All Code Records
          • GETGet Conversation By Id
          • POSTCreate Document
          • POSTBatch Create Document
          • GETGet Document By Id
          • PATCHUpdate Document
          • DELDelete Document By Id
          • DELBatch Delete Document
          • GETGet Documents
          • DELDelete All Documents
          • POSTCreate Guidance
          • GETGet Guidance By Id
          • DELDelete Guidance By Id
          • PATCHUpdate
          • GETGet Guidances
          • GETGet Recent Queries
          • GETGet Slack Install Link
          • POSTIndex Website
          • GETGet Website Status
          • GETGet Website By Id
          • GETGet Websites
          • POSTReindex Website
          • DELDelete Website
          • DELDelete All Websites
      • 概览
      • 工作原理
      • 快速开始
      • 自助设置
      • 项目结构
      • 概览
      • 嵌入模式
      • Hiding content
      • Search
      • 收集用户反馈和建议
      • 完全自定义文档
      • CSS 选择器参考
      • 页眉和页脚
      • 全局主题
      • 可复用片段
      • 概览
      • Fern Writer
      • 预览更改
        • REST API Reference
        • Webhook Reference
        • WebSocket Reference
        • 生成 OpenRPC 参考
        • 生成 gRPC API 参考
        • 生成 GraphQL 参考
        • Library Reference
        • Customize API Reference layout
        • Audiences
        • Write Markdown in API Reference
        • SDK snippets
        • HTTP snippets
        • API Explorer
      • 概览
      • 设置 SEO 元数据
      • 配置 slug
      • 重定向
      • 自定义 robots.txt
      • 概览
        • 密码保护
        • 单点登录
        • 设置 JWT
        • 设置 OAuth
        • 基于角色的访问控制
        • API 密钥注入
      • 概览
      • 概览
      • 设置自托管文档
      • 身份验证
      • 预览
      • 健康检查端点
      • Releases
      • 概览
      • Postman
      • LaunchDarkly 功能标志
      • Segment
      • Mixpanel
      • Analytics events reference
      • Fullstory
      • Intercom
      • Postman 集成
      • Context7
      • 概览
      • 自动更新最后修改日期
      • Cursor
      • 使用 GitLab 托管
      • 使用 Vale
      • 下载 OpenAPI 规范
      • 下载 AsyncAPI 规范
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
在本页
  • 选择您的 API 类型
  • 自定义和增强
预览与发布

API 参考概述

||以 Markdown 格式查看|

Fern 从 OpenAPI 规范 或其他 API 格式生成交互式 API 参考文档。端点、类型架构、代码片段和 AI 生成的示例 都会自动填充。用户可以通过 API 浏览器 直接在文档中尝试请求,AI 代理和爬虫可以通过 API 目录 端点发现您的 API。

选择您的 API 类型

REST

OpenAPI 规范

gRPC

Protocol Buffer .proto 文件

WebSocket

AsyncAPI 规范

Webhook

OpenAPI 规范

OpenRPC

OpenRPC 规范

GraphQL

GraphQL schema

库

Python 或 C++ 源代码

自定义和增强

自定义布局

重新排序端点,按受众筛选,并添加 Markdown 内容

SDK 代码片段

在端点文档中显示 SDK 代码示例

HTTP 代码片段

显示 cURL、Python、JavaScript 和 Go 请求示例

此页面是否有帮助?
在仪表板中编辑
上一个

键盘快捷键

下一个

生成 REST API 参考文档

Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service