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.237.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8bb8c596b6e8a675ccabc69f039664d6451459dccfd459b18e36069e889c101a |
|
MD5 | e316aa5d5f7c2db226ab4eaf4ae3c7c0 |
|
BLAKE2b-256 | b1acee7bb1de4d38b10e0a05a110f1e3697d63c31cb9dc973bc1ca7bf5cdd260 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.237-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbc349552f0a33e875cde940e8362c5118ab999eb49394c88efcf2c8f34dbee7 |
|
MD5 | 9d30fef2cbcdfe56cdefe1086aa50106 |
|
BLAKE2b-256 | abd127368cdc5a5b007713948a3888f7c022ae23417827f2aeb3c9b1448e312b |