Merge pull request #6 from kikuomax/simple-constructor

Replace factory method with constructor

Author: kikuomax

README.ja.md

@@ -21,7 +21,7 @@
 このレポジトリを依存関係(`dependencies`)に追加してください。
 
 ```sh
-npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.1.1
+npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.2.0
 ```
 
 このライブラリはCDK v2プロジェクトで使用することを想定しており、以下のモジュールは`dependencies`ではなく`peerDependencies`に含んでいます。
@@ -32,11 +32,10 @@ CDK v2プロジェクトで使っている限り、これらを別途インス
 
 ## 始める
 
-[`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html)のコンストラクタの代わりに[`RestApiWithSpec.createRestApi`](./api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.createrestapi.md)を使ってください。
-この関数は[`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html)をOpenAPI定義を記述する機能で拡張したオブジェクトを返します。
+[`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html)の代わりに[`RestApiWithSpec`](./api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.md)をインスタンス化してください。
 
 ```ts
-const api = RestApiWithSpec.createRestApi(this, 'example-api', {
+const api = new RestApiWithSpec(this, 'example-api', {
   description: 'Example of RestApiWithSpec',
   openApiInfo: {
     version: '0.0.1',

README.md

@@ -21,7 +21,7 @@ This library is implemented for the CDK **version 2** (CDK v2) and does not work
 Please add this repository to your dependencies.
 
 ```sh
-npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.1.1
+npm install https://github.com/codemonger-io/cdk-rest-api-with-spec.git#v0.2.0
 ```
 
 This library is supposed to be used in a CDK v2 project, so it does not include the following modules in the `dependencies` but does in the `peerDependencies`.
@@ -32,11 +32,10 @@ As long as you are working on a CDK v2 project, you should not have to separatel
 
 ## Getting started
 
-Please use [`RestApiWithSpec.createRestApi`](./api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.createrestapi.md) instead of the constructor of [`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html).
-This function will return an object which augments [`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html) with the features to describe the OpenAPI definition.
+Please instantiate [`RestApiWithSpec`](./api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.md) instead of [`aws_apigateway.RestApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.RestApi.html).
 
 ```ts
-const api = RestApiWithSpec.createRestApi(this, 'example-api', {
+const api = new RestApiWithSpec(this, 'example-api', {
   description: 'Example of RestApiWithSpec',
   openApiInfo: {
     version: '0.0.1',

api-docs/cdk-rest-api-with-spec.api.md

@@ -18,27 +18,18 @@ export interface IAuthorizerWithSpec extends aws_apigateway.IAuthorizer {
     securitySchemeObject?: SecuritySchemeObject;
 }
 
-// @beta
-export interface IBaseResourceWithSpec extends aws_apigateway.IResource {
-    addMethod(httpMethod: string, target?: aws_apigateway.Integration, options?: MethodOptionsWithSpec): aws_apigateway.Method;
-    addResource(pathPart: string, options?: ResourceOptionsWithSpec): IResourceWithSpec;
-    defaultMethodOptions?: MethodOptionsWithSpec;
-    parentResource?: IBaseResourceWithSpec;
-}
-
 // @beta
 export interface IResourceWithSpec extends aws_apigateway.Resource {
     addMethod(httpMethod: string, target?: aws_apigateway.Integration, options?: MethodOptionsWithSpec): aws_apigateway.Method;
     addResource(pathPart: string, options?: ResourceOptionsWithSpec): IResourceWithSpec;
     defaultMethodOptions?: MethodOptionsWithSpec;
-    parentResource?: IBaseResourceWithSpec;
+    parentResource?: IResourceWithSpec;
 }
 
 // @beta
-export interface IRestApiWithSpec extends aws_apigateway.RestApi {
+export interface IRestApiWithSpec extends aws_apigateway.IRestApi {
     addModel(id: string, props: ModelOptionsWithSpec): aws_apigateway.Model;
-    root: IBaseResourceWithSpec;
-    underlying: aws_apigateway.RestApi;
+    readonly root: IResourceWithSpec;
 }
 
 // @beta
@@ -109,18 +100,16 @@ export interface ResourceOptionsWithSpec extends aws_apigateway.ResourceOptions
 }
 
 // @beta
-export type RestApiFactory = (scope: Construct, id: string, props?: aws_apigateway.RestApiProps) => aws_apigateway.RestApi;
-
-// @beta
-export class RestApiWithSpec {
-    static createRestApi(scope: Construct, id: string, props: RestApiWithSpecProps): IRestApiWithSpec;
+export class RestApiWithSpec extends aws_apigateway.RestApi implements IRestApiWithSpec {
+    constructor(scope: Construct, id: string, props: RestApiWithSpecProps);
+    addModel(id: string, props: ModelOptionsWithSpec): aws_apigateway.Model;
     // (undocumented)
     readonly props: RestApiWithSpecProps;
+    readonly root: IResourceWithSpec;
 }
 
 // @beta
 export interface RestApiWithSpecProps extends aws_apigateway.RestApiProps {
-    newRestApi?: RestApiFactory;
     openApiInfo: Partial<InfoObject> & Pick<InfoObject, 'version'>;
     openApiOutputPath: string;
 }

api-docs/markdown/cdk-rest-api-with-spec.ibaseresourcewithspec.addmethod.md

@@ -7,7 +7,7 @@
 > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
 
-[aws\_apigateway.Resource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Resource.html) augmented with the features to build the OpenAPI definition.
+[aws\_apigateway.IResource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IResource.html) augmented with the features to build the OpenAPI definition.
 
 <b>Signature:</b>
 
@@ -16,12 +16,16 @@ export interface IResourceWithSpec extends apigateway.Resource
 ```
 <b>Extends:</b> apigateway.Resource
 
+## Remarks
+
+Although this interface actually inherits [aws\_apigateway.Resource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.Resource.html)<!-- -->, you should rely on only properties defined in [aws\_apigateway.IResource](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigateway.IResource.html)<!-- -->.
+
 ## Properties
 
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
 |  [defaultMethodOptions?](./cdk-rest-api-with-spec.iresourcewithspec.defaultmethodoptions.md) |  | [MethodOptionsWithSpec](./cdk-rest-api-with-spec.methodoptionswithspec.md) | <b><i>(BETA)</i></b> <i>(Optional)</i> Default method options with the OpenAPI definition. |
-|  [parentResource?](./cdk-rest-api-with-spec.iresourcewithspec.parentresource.md) |  | [IBaseResourceWithSpec](./cdk-rest-api-with-spec.ibaseresourcewithspec.md) | <b><i>(BETA)</i></b> <i>(Optional)</i> Parent resource. |
+|  [parentResource?](./cdk-rest-api-with-spec.iresourcewithspec.parentresource.md) |  | [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md) | <b><i>(BETA)</i></b> <i>(Optional)</i> Parent resource. |
 
 ## Methods
 

api-docs/markdown/cdk-rest-api-with-spec.ibaseresourcewithspec.addresource.md

@@ -12,7 +12,7 @@ Parent resource.
 <b>Signature:</b>
 
 ```typescript
-parentResource?: IBaseResourceWithSpec;
+parentResource?: IResourceWithSpec;
 ```
 
 ## Remarks