如何基于Location响应头配置OpenAPI 3 Link并提取GUID参数

你可以通过OpenAPI的表达式语法，从Location响应头的完整URI中提取所需的GUID，并将其传递给关联的getWidgetById接口。下面是具体的配置方案：

方案一：通过路径拆分提取（适用于固定结构的URI） #

修改POST /widgets接口的201响应部分，添加links配置并使用表达式拆分URI：

paths:
  /widgets:
    post:
      operationId: addWidget
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddWidget'
      responses:
        '201':
          headers:
            Location:
              $ref: '#/components/headers/Location'
          links:
            getWidgetById:
              operationId: getWidgetById
              parameters:
                # 拆分URI路径，过滤空值后取最后一段（即GUID）
                widgetId: '{{ $response.headers.location | split("/") | select("ne", "") | last }}'
        '400':
          $ref: '#/components/responses/BadRequest'
  /widgets/{widgetId}:
    get:
      operationId: getWidgetById
      parameters:
        - $ref: '#/components/parameters/WidgetId'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Widget'

方案二：通过正则匹配提取（适用于GUID格式固定的场景） #

如果需要更精准匹配GUID的格式（8-4-4-4-12的十六进制字符串），可以使用正则表达式捕获：

# 在201响应的links参数中替换为以下内容
parameters:
  widgetId: '{{ $response.headers.location | regexReplace("^.*/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})/?$", "$1") }}'

说明 #

• 两种方案均基于OpenAPI 3.0+支持的表达式语法，主流API工具（如Swagger UI、Postman）都能识别并解析这些表达式。
• 方案一依赖URI的路径结构，适用于/widgets/{GUID}这类固定层级的URI；方案二通过正则锁定GUID格式，适配性更强，即使URI结构有微小变化也能正确提取。

内容的提问来源于stack exchange，提问作者David Keaveny