Golang OpenAPI 生成器將自定義標頭添加到請求

Question

賞金將在 5 天后到期。 此問題的答案有資格獲得+50聲望賞金。 Jonathan R正在尋找可靠來源的答案。

是否可以將openapi.yaml中未指定的自定義標頭添加到請求中？

我有類似的東西：

res, err := s.client.MyApi.
        SomeOperation(context.Background(), id).
        SomeOperationRequest(req).
        Execute()

我想為此請求添加一個標頭。 有沒有類似“AddHeader()”的東西。 或者我可以通過上下文以某種方式傳遞它嗎？

我正在使用 OpenAPITools 生成器。

Answer 1

如果您的req僅用於保留正文參數/標頭並在底層實現ClientRequestWriter接口以創建實際請求（其中從您的對象創建的請求用於： https ://github.com/go-openapi/runtime/blob/da56347e36dc1a470118d4306d2821572c3ad14f/ client/request.go#L107 ），如果是這樣，您可以裝飾WriteToRequest方法（來自 ClientRequestWriter 接口）：

type decoratedRequest struct {
  SomeOperationRequest // it must be same type for which defined WriteToRequest method, probably it will be pointer to SomeOperationRequest type
  // here you can add custom headers params if you want
}

func (r *decoratedRequest) WriteToRequest(req ClientRequest, reg strfmt.Registry) error
 if err := r.SomeOperationRequest.WriteToRequest(req, reg); err != nil {
   return err
 }

//here you manualy edit actual request to the server
 return req.SetHeaderParam("your-header", "your-value")
}

生產代碼將如下所示：

res, err := s.client.MyApi.
        SomeOperation(context.Background(), id).
        SomeOperationRequest(decoratedRequest{SomeOperationRequest: req}).
        Execute()

PS：在你的情況下向服務器發出實際請求可能會使用另一個接口，但想法是一樣的

PSS：這將是可行的，但慣用的方法是編輯 openapi.yaml