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.235.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | adfe75b22e7b9268933c45e796706446cdefd4d3cf514b2492a276e65b3a3ed9 |
|
MD5 | 9cf36b5b8537b221c5ed83fed7234ec6 |
|
BLAKE2b-256 | 1af577005809092b7f69ce0034c0b9ba24d3e4767cb99e0bff4cd6bedc61c850 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.235-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4ce9371893400f3ce53d74c39cb4dd1eb5c40be0fc121ff593a03029a40a465f |
|
MD5 | bc94a368f30aff97920515d209b4d63d |
|
BLAKE2b-256 | a1d98420ef4dddec8fe4b7eae5953559b098808ab948746b2a18ae991ec1036f |