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.303.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d60e040ee19e06e934d89773ad7819bc4063738de87442c10888906c25902fd5 |
|
MD5 | 721d00fae55f2bdf72e2b1186fbf365c |
|
BLAKE2b-256 | 8b1ada66707d3d1930b442275d1fb29c861d19e7c6c4b02c403ab071cd4e7000 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.303-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b924af481e468994e6ff61c58c5533cf86d607a0098c1bcf21ba4ee7cc939d57 |
|
MD5 | c4229e3afe672205285a2393f6009fa7 |
|
BLAKE2b-256 | 591e642b7b4abaeb22bca06ca1eaa8cce6116ae5e7b010c37c6831d9f041ffb1 |