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.505.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd812a958f6450650d62a6d02622b6f5137a0c39a526ef3cfe97cc29b17ed4fa |
|
MD5 | 4fb460ad7d83d61a75cc6f174b8d572b |
|
BLAKE2b-256 | 4a5ee01f284d43b258da4ce6a9e3e9878406fdf7e7c196c8dc0d4b9e3e17e157 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.505-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d471d30808ce693f56d3ca958c8bf3a45aea8bff083be743bd304efddb7b7a2 |
|
MD5 | 45687c9145afda4f6e72ed1c297ae96d |
|
BLAKE2b-256 | 337265ad4663e9bd6c7588bbee94a0f11d5b1e03a3533241b869d757c86c8df5 |