GoLang与sw-sagger响应头

时间:2018-07-13 21:01:14

标签: go header httpresponse go-swagger

我刚接触golang并尝试设置响应头。我有两个要设置的标题。我认为我误解了一些基本知识。我也正在使用go-swagger生成端点。

我的问题是我似乎只能设置两个标头之一。 Swagger在返回时(在“如果成功”块中)提供了一个函数“ auth.NewAuthLoginUserOK()。WithProfileHeader(“ pickles)”。如何设置两个标头参数?

func AuthLoginRouteHandler(params auth.AuthLoginUserParams) middleware.Responder {
    transactionId := redFalconLogger.GetTransactionId()
    redFalconLogger.LogDebug("AuthLoginRouteHandler", transactionId)

    email := params.Body.Email
    password := params.Body.Password

    //Check to ensure that they are not nil
    if email == "" || password == ""{
        redFalconLogger.LogError("Got an empty string on a username/password", transactionId)
        return auth.NewAuthLoginUserBadRequest()
    }

    //use pointers to limit in flight private data
    pointerEmail := &email
    pointerPassword := &password

    //Call the auth domain
    success := authDomain.LoginUser(pointerEmail,pointerPassword,transactionId)

    if success {
        return auth.NewAuthLoginUserOK().WithProfileKeyHeader("pickles")
    }
    redFalconLogger.LogDebug("Failed Login: ", transactionId)
    return auth.NewAuthLoginUserBadRequest()
}

谢谢。

2 个答案:

答案 0 :(得分:0)

go-swagger将为规范中定义的针对结果对象的响应标头(由auth.NewAuthLoginUserOK()返回的内容)生成一个方法

如果您在生成的规范中定义了多个响应标头,则只需链接调用即可。

return auth.NewAuthLoginUserOK().WithProfileKeyHeader("pickles").WithOtherHeader("cucumbers")

您应尽量避免偏离规格。如果您绝对需要编写规范中未指定的标头,则响应对象将具有ServeHTTP方法,您可以使用该方法获取stdlib的ResponseWriter。

    return auth.NewAuthLoginUserOK().ServeHTTP(func(rw http.ResponseWriter, r *http.Request) {
        // Try and avoid this
        rw.Header().Add("profile", "pickles")
        rw.Header().Add("other-header", "cucumbers")
    })

答案 1 :(得分:0)

您可以尝试以下解决方案。在您的swagger.yml

中进行这样的定义
/deviceProvisioningDetails/{deviceId}:
    get:
      tags:
        - tenantManager
      operationId: getDeviceID
      parameters:
            - name: deviceId
              in: path
              description: Device ID
              required: true
              type: string
            - name: requestId
              in: header
              required: true
              description: "request id"
              type: string
      responses:
        200:
          description: OK
          headers:
            tenantId:
              type: string
              description: "Tenant Id"

然后在您的configure.go中,您可以返回有效载荷。

  return tenant_manager.NewGetDeviceIDOK().WithTenantID(tenantId)