api.yml 配置文件

一个 fern/ 文件夹包含一个名为 api.yml 的特殊文件，其中包括所有 API 范围的配置。

$
fern/
$
├─ fern.config.json
$
├─ generators.yml
$
└─ definition/
$
  ├─ api.yml
$
  ├─ pet.yml
$
  ├─ store.yml
$
  └─ user.yml

API 名称

此名称用于在您的组织中唯一标识您的 API。如果您只有一个 API，那么 api 就是一个足够的名称。

1
name: api

API 描述

您可以定义顶级 API 描述。此描述将出现在 OpenAPI 规范和 Postman 集合中。

1
name: api
2
docs: | 
3
  ## Header
4
  This API provides access to...

API 版本

您可以定义基于请求头的 API 版本控制方案，例如 X-API-Version。支持的版本和默认值指定如下：

1
version:
2
  header: X-API-Version
3
  default: "2.0.0"
4
  values:
5
    - "1.0.0"
6
    - "2.0.0"
7
    - "latest"