自定义参数名称 (OpenAPI) | Fern Documentation

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

请求头

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

paths:
  "/user":
    get:
      operationId: list_user
      parameters:
        - in: header
          name: X-API-Version
          x-fern-parameter-name: version
          schema:
            type: string
          required: true

查询参数

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

paths:
  "/user/search":
    get:
      operationId: search_user
      parameters:
        - in: query
          name: q
          x-fern-parameter-name: search_terms
          schema:
            type: string
          required: false

路径参数

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

paths:
  "/user/{userId}":
    get:
      operationId: get_user
      parameters:
        - in: path
          name: userId
          x-fern-parameter-name: id
          schema:
            type: string
          required: false