Add SwaggerUI to your AWS Apigateway RestApi
Project description
CDK Apigateway SwaggerUI
Add SwaggerUI to your AWS Apigateway RestApi
Install
TypeScript
npm install @pepperize/cdk-apigateway-swagger-ui
or
yarn add @pepperize/cdk-apigateway-swagger-ui
Python
pip install pepperize.cdk-apigateway-swagger-ui
C# / .Net
dotnet add package Pepperize.CDK.ApigatewaySwaggerUi
Java
<dependency>
<groupId>com.pepperize</groupId>
<artifactId>cdk-apigateway-swagger-ui</artifactId>
<version>${cdkApigatewaySwaggerUi.version}</version>
</dependency>
Usage
import { Stack } from "aws-cdk-lib";
import * as apigateway from "aws-cdk-lib/aws-apigateway";
import { SwaggerUi } from "@pepperize/cdk-apigateway-swagger-ui";
const stack = new Stack();
const restApi = new apigateway.RestApi();
new SwaggerUi(stack, "SwaggerUI", { resource: restApi.root });
- Open your SwaggerUI:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs/swagger-ui.html
- View your API docs:
https://<rest api id>.execute-api.<aws region>.amazonaws.com/<stage>/api-docs.json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for pepperize.cdk-apigateway-swagger-ui-0.0.578.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | baac4f313b1c228a560fdd9b27ee50a7b139fe31ad82fad10f0727f589ef36a1 |
|
MD5 | ace87b875bf6966926cbe3ef62ed72c5 |
|
BLAKE2b-256 | 06948c61dd220bca518e2f495dc78e68e4a739d5cae29fc16a83974ccc7aba23 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.578-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb1d84db0f2dc368cc42f029655671a9668244fa6893566f1b8677bd2053fa21 |
|
MD5 | 9254ffc60fa84cc53cb41a581635c1f9 |
|
BLAKE2b-256 | 2fc6ea044e45181de668f337160bd9b403bee5cedd9c8a213f8350ce6f92fe3f |