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.447.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1404ea368718fb0c8ca9cb80cf169d9f2baece5fda585e3f67390f3824f6107c |
|
MD5 | 6d483a30fc4e062212ce9fece6157afc |
|
BLAKE2b-256 | baab07354d3d44835a47063dc5afc09a25fc5cfa6f010ba73ce0089b98c10942 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.447-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 593578f6801a4ecee13e0c44721454cf50b6688f7087a46c45901161a4708fa8 |
|
MD5 | a10a0cc09b0f749b98078c6f05b38f31 |
|
BLAKE2b-256 | 5c4ff93223838133e08aeff3295d4d43662a8ac385fef81048fa651f713be9f0 |