Lessons learned from generating SDKs for a virus and malware scan API with Amazon API Gateway, Smithy, and OpenAPI Generator.

Cloudonaut's resource offers insights, tutorials, and resources for cloud architects and AWS users. Readers can learn about AWS services, cloud architecture patterns, and best practices for cloud-native development. With articles, guides, and case studies, Cloudonaut provides  guidance and expertise for designing and managing scalable and resilient cloud solutions on AWS.

cloudonaut

Explores three approaches for generating SDKs from Amazon API Gateway REST APIs: built-in API Gateway SDK generation (limited abstraction), Smithy IDL (powerful but AWS-focused with immature tooling), and OpenAPI Generator with optimized specifications (best results). The key insight is creating a separate, SDK-optimized OpenAPI document rather than using the deployment specification directly, resulting in more usable client libraries for JavaScript, Java, Python, and TypeScript.

How to generate SDKs for a REST API powered by Amazon API Gateway

Built-in function: Generate SDKs for REST APIs

Smithy: Interface Definition Language (IDL)

OpenAPI Generator: Generate from OpenAPI documents