Forum Discussion

aditya_g's avatar
aditya_g
Occasional Visitor
5 years ago

How to add AWS authentication to my OPEN API SPEC

I am documenting an existing API with OpenAPI. The API uses AWS authentication.  I have been testing the API using postman, where I add Aws access key and Signature in the Auth section of Postman. Bu...
Swagger Editor
Swagger UI
HKosova's avatar
HKosova
Icon for Alumni rankAlumni
5 years ago

OpenAPI does not have special support for AWS signatures. It can only be defined as a genetic Authorization header:

components:
  securitySchemes:
    awsSigV4:
      type: apiKey
      in: header
      name: Authorization

security:
  - awsSigV4: []

 

But Swagger UI provides requestInterceptor to change outgoing requests, which can be used to calculate the AWS signature similar to how Postman does this. Check out these posts:

How to calculate AWS signature V4 in Swagger before request

SwaggerJS/API Explorer using AWS Sigv4 authentication on Amazon API Gateway

 

Hope this helps!