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.494.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e2a793ddc30bd8b1f4d562833ade002b24d7d22b8d518c8e65006ae77b71954e |
|
MD5 | 1427cd055b8cd599065426dd8c15c556 |
|
BLAKE2b-256 | 098e59ee283556566b815cafd8dbf29e58979401feec521f3843fe4533da383e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.494-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b89dc99fe66dea27740c9a9b33be7f63535e41fbf635f4c1895bfbd0f87d9659 |
|
MD5 | 356839d080c1b5efbf06193c601e3773 |
|
BLAKE2b-256 | 97054668c0f7379ef9702daea0b62e4897bacac95c6f9fc304ec9305283ec1e1 |