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.413.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ba860c7fc0d887917da34eb01e5549a705743b23ff8e4d71c1bf47211414ae3 |
|
MD5 | 857fddd047dc6f9c158e1e85ab53a692 |
|
BLAKE2b-256 | 4ce4664d158b2d6c8de6b5d081e03b3ee077f2aa8c38d193e2827739b88bd5df |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.413-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d550525ce6c2e1a761e2267e3f55d482944aad1f2a9f9a0343a9cf7398ed3ba |
|
MD5 | 1bc98b4943e4bddea7ef2b68c6ce14ba |
|
BLAKE2b-256 | 37deead932624758a26105bb76674f5ba7df59d60140335c7fc3cf26d7a95381 |