使用OAS3將object放入REST請求header

Question

在此頁面https://swagger.io/docs/specification/serialization/章節“標頭參數”中有一個 header object 的示例：

X-MyHeader: role=admin,firstName=Alex

這在 OAS3 中如何實現？

這是我試過的：

openapi: "3.0.0"
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
servers:
  - url: http://localhost:8080/api
paths:
  /pet:
    post:
      summary: Create a pet
      operationId: addPet  
      tags:
        - pet
      parameters: 
        - name: X-MyHeader
          in: header
          schema:
            $ref: '#/components/schemas/X-MyHeader'
      requestBody:
        $ref: '#/components/requestBodies/postPet'
      responses:
        '200':
          description: Pet added

components:
  schemas:
    Pet:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
    X-MyHeader:
        type: object
        properties:
          role:
            type: string
          firstName:
            type: string
  requestBodies:
    postPet:
      description: Pet object that needs to be added to the store
      required: true
      content:
         application/json:
          schema:
            $ref: '#/components/schemas/Pet'

使用 openapi-generator-maven-plugin 版本 4.3.0 創建客戶端代碼並運行測試時，我收到此錯誤消息：

    java.lang.IllegalArgumentException: Unexpected char 0x0a at 17 in X-MyHeader value: class XMyHeader {
    role: admin
    firstName: Alex
}
    at okhttp3.Headers$Companion.checkValue(Headers.kt:434)
    at okhttp3.Headers$Companion.access$checkValue(Headers.kt:346)
    at okhttp3.Headers$Builder.set(Headers.kt:328)
    at okhttp3.Request$Builder.header(Request.kt:199)
    at org.openapitools.client.ApiClient.processHeaderParams(ApiClient.java:1137)
    at org.openapitools.client.ApiClient.buildRequest(ApiClient.java:1036)
    at org.openapitools.client.ApiClient.buildCall(ApiClient.java:1010)
    at org.openapitools.client.api.PetApi.addPetCall(PetApi.java:101)
    at org.openapitools.client.api.PetApi.addPetValidateBeforeCall(PetApi.java:113)
    at org.openapitools.client.api.PetApi.addPetWithHttpInfo(PetApi.java:148)
    at org.openapitools.client.api.PetApi.addPet(PetApi.java:131)
    at org.openapitools.client.api.PetApiTest.addPetTest(PetApiTest.java:93)
    at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
    at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke(Method.java:498)
    at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50)
    at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12)
    at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47)
    at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17)
    at org.junit.internal.runners.statements.RunBefores.evaluate(RunBefores.java:26)
    at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325)
    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78)
    at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57)
    at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290)
    at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71)
    at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288)
    at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58)
    at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268)
    at org.junit.runners.ParentRunner.run(ParentRunner.java:363)
    at org.eclipse.jdt.internal.junit4.runner.JUnit4TestReference.run(JUnit4TestReference.java:89)
    at org.eclipse.jdt.internal.junit.runner.TestExecution.run(TestExecution.java:41)
    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:541)
    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.runTests(RemoteTestRunner.java:763)
    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.run(RemoteTestRunner.java:463)
    at org.eclipse.jdt.internal.junit.runner.RemoteTestRunner.main(RemoteTestRunner.java:209)

該代碼試圖在 header 中放置一個換行符，這是不允許的。

如何使用 OAS3 和 OpenApi 生成器將對象放入 HTTP 標頭中？

Answer 1

雖然我自己在 openapi 3.0 中進行了一些有關訪問HTTP 請求特定 header 信息的研究，但我認為我可能偶然發現了解決您問題的方法。 查看https://github.com/go-swagger/go-swagger/issues/1918 ，其中給出了在響應中創建自定義 header 參數的解決方案。