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.611.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c9079609d42914da45dfcae29f13c0e6b9735f892aecf77db92d8257d78ebcd |
|
MD5 | 20f27e83830ceed330ffeca86680cdaf |
|
BLAKE2b-256 | e6529bebb16512e9190de28c34926c8f85d552bb3309747e5826c276dceb0c08 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.611-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 180f5c501a7a4c525bea15a69c53caf51c19ca231cdade7f97f5cff0d3156287 |
|
MD5 | fdcb2707dcaa9e85e89d394ed16cd5c0 |
|
BLAKE2b-256 | fc81d6c390b59e64921b4290ab744909fb3562d02d61269d6a2d31a0cd01f0b6 |