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.613.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad4c723d51e79c73fbe8af135ae9c0d10d8ca70fd7462caac4b89eac0166d8c2 |
|
MD5 | 2b83b2ae42a6bcb5c00ffcf916b9bec6 |
|
BLAKE2b-256 | af85ad6843b2e28dba9d3635c51cc2516b55cbe97084b21c9703917c5f1c731f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.613-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 51cc63d39ad324ca7ec29261a8665dd7801ab347b4d7643d691d5eaf5de0a9d9 |
|
MD5 | a0c2c6240445832cc453df5ddda15b18 |
|
BLAKE2b-256 | 20c1a99d68e7df30d6c9e4d0f0ba847570afa8d54a3a6bd78256a28fb86a07ee |