swagger support for RestApi

[vertti]

I'd like to attach our API's Swagger documentation (swagger.json) to the Api Gateway rest api. Apparently you can do it simply by including a Body field to the rest api Properties but it seems this is not supported by CDK?

Use Case

We took the base swagger json generated by API Gateway and improved it by adding documentation to it. Now I'd like to include it to the Cloudformation so it's available for browsing in the API Gateway Documenatiion page in the AWS Console.

Proposed Solution

Here is blog post showing how you can add the swagger doc directly under the Body like:

AWSTemplateFormatVersion: '2010-09-09'
Resources:
  PlayersAPI:
    Type: AWS::ApiGateway::RestApi
    Properties:
      Name: Player API
      Description: A demo API for Player management
      Body: # Swagger Specification body goes here

• 👋 I may be able to implement this feature request
• ⚠️ This feature might incur a breaking change

---

This is a 🚀 Feature Request

[vertti]

Currently you can attach the custom json with the following:

import openapiJson = require('./resources/openapi.json')

..
const cfnRestApi = api.node.defaultChild as CfnRestApi
cfnRestApi.body = openapiJson

where api is an instance of LambdaRestApi.

[nija-at]

If I understand correctly, uploading the swagger.json or swagger.yaml file into the Body or the BodyS3Location property would also modify the Rest API methods and resources, and not only documentation.

[nija-at]

This is a duplicate of #1461.

Apologies for the churn, but it would be useful to move your 👍 reactions and any additional comments to the other issue.