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.623.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78d6c87ab265da1c7cc36acda71c1001f35cdbce5dbb6adfa2fea5002485c0bc |
|
MD5 | acccf02426537430a1af756cc5442906 |
|
BLAKE2b-256 | e025f6d7e2aa061c79da312c630a3ee91e128eea9fee42ff884f8f97a177096e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.623-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fc7293ab4e7b7ed23674905ad41ef7f46e26666542a7b50e8a4853d576fd3c61 |
|
MD5 | 58c40d9b8671c60744d13dd6835c5575 |
|
BLAKE2b-256 | d047b838a61d7251b3bee5868ccb3e57fa1d59ee8c68a3dac3e356cd1bf3fe3c |