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.351.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36517d57447a12537134668672e05ffc788252c39d62ce658c3bda82fdea5a98 |
|
MD5 | 0ab37c54960a819d4f04732a26f310ce |
|
BLAKE2b-256 | b2efc75583fc0f9dd16331d6ce79c7213e24fd6da02eb4c0e8511d730c5799a7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.351-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d235ca2ec529bb58a3e3de3067e89198b60cc1ed9086ddd52b61bff599213c5c |
|
MD5 | b1b052cefeaf53f1b517f346b891df38 |
|
BLAKE2b-256 | 77ca697cc1f367536f771799edb0a4dedc89257ab6a2242c467798519c76b851 |