如何在请求前在Swagger中计算AWS签名V4

Question

对于我们的AWS APIendpoint，我们使用AWS_IAM授权，并希望从Swagger UI进行调用。要成功调用，必须有两个标题“Authorization”和“x-amz-date”。为了形成“授权”，我们使用aws文档中的以下步骤。我们必须在每次通话中更改“x-amz-date”才能通过授权。问题是：如何在Swagger中编写脚本来签署请求，该脚本在每次请求发送到aws之前都会运行？（我们知道如何在加载Swagger页面之前一次性指定两个标题，但在每次调用之前应该重新运行此过程）。

提前谢谢。

Answer 1

您可以非常容易地将AWS SDK中的签名修改成SwaggerJS(从而修改SwaggerUI)。看这里

我这里有一个稍微修改过的SwaggerUI。给定一些AWS凭据和一个API ID，它将下拉Swagger定义，将其显示在SwaggerUI中，然后您可以使用sigv4调用API。

Authorizer实现如下所示：

var AWSSigv4RequestSigner = function(credentialProvider, aws) {
  this.name = "sigv4";
  this.aws = aws;
  this.credentialProvider = credentialProvider;
};

AWSSigv4RequestSigner.prototype.apply = function(options, authorizations) {
  var serviceName = "execute-api";

  //If we are loading the definition itself, then we need to sign for apigateway.
  if (options && options.url.indexOf("apigateway") >= 0) {
    serviceName = "apigateway";
  }

  if(serviceName == "apigateway" || (options.operation && options.operation.authorizations && options.operation.authorizations[0].sigv4))
  {
    /**
     * All of the below is an adapter to get this thing into the right form for the AWS JS SDK Signer
     */
    var parts = options.url.split('?');
    var host = parts[0].substr(8, parts[0].indexOf("/", 8) - 8);
    var path = parts[0].substr(parts[0].indexOf("/", 8));
    var querystring = parts[1];

    var now = new Date();
    if (!options.headers)
    {
     options.headers = [];
    }

    options.headers.host = host;
    if(serviceName == "apigateway")
    {
      //For the swagger endpoint, apigateway is strict about content-type
      options.headers.accept = "application/json";
    }

    options.pathname = function () {
      return path;
    };
    options.methodIndex = options.method;
    options.search = function () {
      return querystring ? querystring : "";
    };
    options.region = this.aws.config.region || 'us-east-1';

    //AWS uses CAPS for method names, but swagger does not.
    options.method = options.methodIndex.toUpperCase();

    var signer = new this.aws.Signers.V4(options, serviceName);


    //Actually add the Authorization header here
    signer.addAuthorization(this.credentialProvider, now);

    //SwaggerJS/yourbrowser complains if these are still around
    delete options.search;
    delete options.pathname;
    delete options.headers.host;
    return true;
  }
  return false;
};

Answer 2

swagger-js中有内置的支持来添加< code>requestInterceptor来实现这一点。swagger-ui项目在幕后使用了swagger-js。

只需创建一个请求拦截器，如下所示：

requestInterceptor: {
  apply: function (request) {
    // modify the request object here
    return request;
  }
}

并在创建时将其应用于您的昂首阔步实例：

window.swaggerUi = new SwaggerUi({
  url: url,
  dom_id: "swagger-ui-container",
  requestInterceptor: requestInterceptor,

在这里，您可以在请求对象中设置标头（注意，这不是标准的javascript http请求对象，请检查它以获取详细信息）。但是您确实可以访问此处的所有标头，因此您可以根据需要计算和注入它们。