swagger-api / swagger-api/swagger-codegen
[Discussion] Support for AWS SigV4 in clients
@HugoMario is already working on this.
Since May 20, 2021.
- Dominant language
- Mustache
- Stars
- 17.8k
- Forks
- 6k
- PR merge metrics
- No merged PRs in 30d
Description
Swagger Codegen team,
Would there be any appetite for supporting the ability to sign requests from client SDKs, using Amazon's Signature V4 (SigV4)?
Amazon's API Gateway provides vendor extensions for modeling these requirements in Swagger and OpenAPI 3 here. These will likely be simplified in their new HTTP API offering as well in the near future.
Would you argue that it's frowned upon to support vendor extensions in the CodeGen project? Or perhaps there is some sort of "opt-in" mechanism at runtime to indicate that the user wants the vendor's extensions to be interpreted?
Disclosure
I work on the API Gateway team. We've previously generated SDKs for our customers using internal systems. We are considering a new direction whereby customers would be encouraged to use Swagger Codegen, but the lack of SigV4 signing may be a problem for many customers who use it to protect their APIs.
We are considering adding the support to this project, but would appreciate the team's opinion before digging into it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.