[aws-apigateway] ApiKey is not supported for SpecRestApi

[marcogrcr]

There's an API disparity for ApiKey between RestApi and SpecRestApi constructs:

aws-cdk/packages/@aws-cdk/aws-apigateway/lib/api-key.ts

Lines 48 to 54 in 2b474b9

	export interface ApiKeyProps extends ApiKeyOptions {
	/**
	* [disable-awslint:ref-via-interface]
	* A list of resources this api key is associated with.
	* @default none
	*/
	readonly resources?: RestApi[];

Notice how resources is of type RestApi[] instead of IRestApi[], making this impossible:

class MyStack extends Stack {
  constructor(scope: Construct, id: string, props: StackProps) {
    super(scope, id, props);

    const api = new SpecRestApi(this, "MyApi", {
      apiDefinition: ApiDefinition.fromInline({ /* (... )*/ }),
    });
    new ApiKey(this, "MyApi", {
      // ERROR: Type 'SpecRestApi' is missing the following properties from type 'RestApi': methods, deployments, url, addApiKey, and 2 more.
      resources: [api],
    });
  }
}

Additionally, the convenience method:

aws-cdk/packages/@aws-cdk/aws-apigateway/lib/restapi.ts

Lines 712 to 717 in 2b474b9

	public addApiKey(id: string, options?: ApiKeyOptions): IApiKey {
	return new ApiKey(this, id, {
	resources: [this],
	...options,
	});
	}

Is only available in RestApi. It should probably be moved to RestApiBase so SpecRestApi can benefit from it as well.

Fortunately, this disparity doesn't make it impossible to create/associate an API key to an API:

class MyStack extends Stack {
  constructor(scope: Construct, id: string, props: StackProps) {
    super(scope, id, props);

    const api = new SpecRestApi(this, "MyApi", {
      apiDefinition: ApiDefinition.fromInline({}),
    });

    // option 1
    new UsagePlan(this, "MyUsagePlan", {
      apiKey: new ApiKey(this, "MyApi"),
      apiStages: [{ stage: api.deploymentStage }],
    });

    // option 2
    api.addUsagePlan("MyUsagePlan", {
      apiStages: [{ stage: api.deploymentStage }],
    });
  }
}

As a side note, option 2 from the previous example has an unnecessary requirement to assign a value to apiStages in order to bind it to the API.

I believe this could be improved by changing:

aws-cdk/packages/@aws-cdk/aws-apigateway/lib/restapi.ts

Lines 350 to 352 in 2b474b9

	public addUsagePlan(id: string, props: UsagePlanProps = {}): UsagePlan {
	return new UsagePlan(this, id, props);
	}

to:

public addUsagePlan(id: string, props: UsagePlanProps = {}): UsagePlan {
  return new UsagePlan(this, id, {
    apiStages: [
      { stage: this.deploymentStage },
      ...(props.apiStages?.filter((x) => x.stage != this.deploymentStage) ||
        []),
    ],
    ...props,
  });
}

Reproduction Steps

See description above

What did you expect to happen?

1. RestApi and SpecRestApi have API parity for dealing with API keys.
2. Calling RestApiBase.prototype.addUsagePlan() automatically binds the usage plan to the RestApiBase instance.

What actually happened?

1. The APIs are different.
2. Calling RestApiBase.prototype.addUsagePlan() does not bind the usage plan to the RestApiBase instance. It has to be specified in the apiStages field of the UsagePlanProps parameter.

Environment

• CLI Version: 1.68.0
• Framework Version: 1.69.0
• Node.js Version: 12.13.0
• OS: macOS 10.14.6
• Language (Version): typescript@4.0.3

Other

N/A

---

This is 🐛 Bug Report

[nija-at]

Marking this as a feature request to support API keys with SpecRestApi.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.