OpenAPI扩展

自定义参数名称

以 Markdown 格式查看

x-fern-parameter-name 扩展允许您在生成的 SDK 中自定义参数的变量名称。

请求头

在下面的示例中，请求头 X-API-Version 在生成的 SDK 中被重命名为 version。这种重命名使 SDK 更具可读性。

1paths:
2  "/user":
3    get:
4      operationId: list_user
5      parameters:
6        - in: header
7          name: X-API-Version
8          x-fern-parameter-name: version
9          schema:
10            type: string
11          required: true

查询参数

在下面的示例中，查询参数 q 在生成的 SDK 中被重命名为 search_terms。这种重命名使参数对最终用户更加友好。

1paths:
2  "/user/search":
3    get:
4      operationId: search_user
5      parameters:
6        - in: query
7          name: q
8          x-fern-parameter-name: search_terms
9          schema:
10            type: string
11          required: false

路径参数

在下面的示例中，路径参数 userId 在生成的 SDK 中被重命名为 id。这种重命名使 SDK 更加简洁。

1paths:
2  "/user/{userId}":
3    get:
4      operationId: get_user
5      parameters:
6        - in: path
7          name: userId
8          x-fern-parameter-name: id
9          schema:
10            type: string
11          required: false