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.426.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a8f3235d58a57003a0ca4a5136f0137be745864f7993c9dfa1cf8615a5412772 |
|
MD5 | 2b8bb6d296ee0c8153a462b3544033a4 |
|
BLAKE2b-256 | ed302a5ee7db475f8e7942600ecbffdbec291ad688daf1181fb7d9a87b8f6222 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.426-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | de2be62409e3f79ede768907591e9ff14e3c6731735ee1ad64939c5398d91902 |
|
MD5 | 752a8327bffb9f36c7ee450ee0d27d60 |
|
BLAKE2b-256 | f08df220c5c387e8376a4ddf23fd5597b4723cd050895ca6c743754367cbe72b |