Generate schema for API Gateway responses

[Spencer Markowski]

Summary

Add Model definition to schema when building API Gateway templates. Optionally, allow JSON schema to be defined for each endpoint.

Motivation

When schema is defined in API Gateway it's possible to use the SDK to generate API clients directly from AWS. Without the schema the SDK is a useless pile of garbage.

Reference-level explanation

When using models in Jets, we should have enough information to create AWS::ApiGateway::Model. When building the CFN templates for API Gateway we could add the appropriate definition.

Type: AWS::ApiGateway::Model
Properties: 
  ContentType: String
  Description: String
  Name: String
  RestApiId: String
  Schema: Json

I'm going to take a stab at implementing this, but wanted to stub out a feature for reference.

[Tung Nguyen]

Jets 6 works by deploying Rails now. So this would probably be implemented as a Rails engine or plugin now.

Related

• https://blog.boltops.com/2024/05/23/ruby-on-jets-6-0-rails-support/
• https://learn.boltops.com/curriculums/ruby-on-jets/courses/ruby-on-jets-6-0-guide/lessons/serverless-rails-on-aws-lambda-with-jets
• https://docs.rubyonjets.com/docs/learn/rails/