-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(apigateway): create RestApi from an OpenAPI spec
Co-authored-by: Niranjan Jayakar <[email protected]> Ability to import an OpenAPI definition to an API Gateway Rest API. The definition can either be a file as a local asset, inline JSON or a key in an S3 bucket. closes #4421
- Loading branch information
Ben Giles
authored
May 11, 2020
1 parent
d8eec54
commit 31014ca
Showing
12 changed files
with
1,099 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,205 @@ | ||
| import * as s3 from '@aws-cdk/aws-s3'; | ||
| import * as s3_assets from '@aws-cdk/aws-s3-assets'; | ||
| import * as cdk from '@aws-cdk/core'; | ||
|
|
||
| /** | ||
| * Represents an OpenAPI definition asset. | ||
| * @experimental | ||
| */ | ||
| export abstract class ApiDefinition { | ||
| /** | ||
| * Creates an API definition from a specification file in an S3 bucket | ||
| * @experimental | ||
| */ | ||
| public static fromBucket(bucket: s3.IBucket, key: string, objectVersion?: string): S3ApiDefinition { | ||
| return new S3ApiDefinition(bucket, key, objectVersion); | ||
| } | ||
|
|
||
| /** | ||
| * Create an API definition from an inline object. The inline object must follow the | ||
| * schema of OpenAPI 2.0 or OpenAPI 3.0 | ||
| * | ||
| * @example | ||
| * ApiDefinition.fromInline({ | ||
| * openapi: '3.0.2', | ||
| * paths: { | ||
| * '/pets': { | ||
| * get: { | ||
| * 'responses': { | ||
| * 200: { | ||
| * content: { | ||
| * 'application/json': { | ||
| * schema: { | ||
| * $ref: '#/components/schemas/Empty', | ||
| * }, | ||
| * }, | ||
| * }, | ||
| * }, | ||
| * }, | ||
| * 'x-amazon-apigateway-integration': { | ||
| * responses: { | ||
| * default: { | ||
| * statusCode: '200', | ||
| * }, | ||
| * }, | ||
| * requestTemplates: { | ||
| * 'application/json': '{"statusCode": 200}', | ||
| * }, | ||
| * passthroughBehavior: 'when_no_match', | ||
| * type: 'mock', | ||
| * }, | ||
| * }, | ||
| * }, | ||
| * }, | ||
| * components: { | ||
| * schemas: { | ||
| * Empty: { | ||
| * title: 'Empty Schema', | ||
| * type: 'object', | ||
| * }, | ||
| * }, | ||
| * }, | ||
| * }); | ||
| */ | ||
| public static fromInline(definition: any): InlineApiDefinition { | ||
| return new InlineApiDefinition(definition); | ||
| } | ||
|
|
||
| /** | ||
| * Loads the API specification from a local disk asset. | ||
| * @experimental | ||
| */ | ||
| public static fromAsset(file: string, options?: s3_assets.AssetOptions): AssetApiDefinition { | ||
| return new AssetApiDefinition(file, options); | ||
| } | ||
|
|
||
| /** | ||
| * Called when the specification is initialized to allow this object to bind | ||
| * to the stack, add resources and have fun. | ||
| * | ||
| * @param scope The binding scope. Don't be smart about trying to down-cast or | ||
| * assume it's initialized. You may just use it as a construct scope. | ||
| */ | ||
| public abstract bind(scope: cdk.Construct): ApiDefinitionConfig; | ||
| } | ||
|
|
||
| /** | ||
| * S3 location of the API definition file | ||
| * @experimental | ||
| */ | ||
| export interface ApiDefinitionS3Location { | ||
| /** The S3 bucket */ | ||
| readonly bucket: string; | ||
| /** The S3 key */ | ||
| readonly key: string; | ||
| /** | ||
| * An optional version | ||
| * @default - latest version | ||
| */ | ||
| readonly version?: string; | ||
| } | ||
|
|
||
| /** | ||
| * Post-Binding Configuration for a CDK construct | ||
| * @experimental | ||
| */ | ||
| export interface ApiDefinitionConfig { | ||
| /** | ||
| * The location of the specification in S3 (mutually exclusive with `inlineDefinition`). | ||
| * | ||
| * @default - API definition is not an S3 location | ||
| */ | ||
| readonly s3Location?: ApiDefinitionS3Location; | ||
|
|
||
| /** | ||
| * Inline specification (mutually exclusive with `s3Location`). | ||
| * | ||
| * @default - API definition is not defined inline | ||
| */ | ||
| readonly inlineDefinition?: any; | ||
| } | ||
|
|
||
| /** | ||
| * OpenAPI specification from an S3 archive. | ||
| * @experimental | ||
| */ | ||
| export class S3ApiDefinition extends ApiDefinition { | ||
| private bucketName: string; | ||
|
|
||
| constructor(bucket: s3.IBucket, private key: string, private objectVersion?: string) { | ||
| super(); | ||
|
|
||
| if (!bucket.bucketName) { | ||
| throw new Error('bucketName is undefined for the provided bucket'); | ||
| } | ||
|
|
||
| this.bucketName = bucket.bucketName; | ||
| } | ||
|
|
||
| public bind(_scope: cdk.Construct): ApiDefinitionConfig { | ||
| return { | ||
| s3Location: { | ||
| bucket: this.bucketName, | ||
| key: this.key, | ||
| version: this.objectVersion, | ||
| }, | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * OpenAPI specification from an inline JSON object. | ||
| * @experimental | ||
| */ | ||
| export class InlineApiDefinition extends ApiDefinition { | ||
| constructor(private definition: any) { | ||
| super(); | ||
|
|
||
| if (typeof(definition) !== 'object') { | ||
| throw new Error('definition should be of type object'); | ||
| } | ||
|
|
||
| if (Object.keys(definition).length === 0) { | ||
| throw new Error('JSON definition cannot be empty'); | ||
| } | ||
| } | ||
|
|
||
| public bind(_scope: cdk.Construct): ApiDefinitionConfig { | ||
| return { | ||
| inlineDefinition: this.definition, | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * OpenAPI specification from a local file. | ||
| * @experimental | ||
| */ | ||
| export class AssetApiDefinition extends ApiDefinition { | ||
| private asset?: s3_assets.Asset; | ||
|
|
||
| constructor(private readonly path: string, private readonly options: s3_assets.AssetOptions = { }) { | ||
| super(); | ||
| } | ||
|
|
||
| public bind(scope: cdk.Construct): ApiDefinitionConfig { | ||
| // If the same AssetAPIDefinition is used multiple times, retain only the first instantiation. | ||
| if (this.asset === undefined) { | ||
| this.asset = new s3_assets.Asset(scope, 'APIDefinition', { | ||
| path: this.path, | ||
| ...this.options, | ||
| }); | ||
| } | ||
|
|
||
| if (this.asset.isZipArchive) { | ||
| throw new Error(`Asset cannot be a .zip file or a directory (${this.path})`); | ||
| } | ||
|
|
||
| return { | ||
| s3Location: { | ||
| bucket: this.asset.s3BucketName, | ||
| key: this.asset.s3ObjectKey, | ||
| }, | ||
| }; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.