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.919.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f21a349bd2bb4cc911544b10b24b3ab8d450c044f581ba43a7cabcb4d11047af |
|
MD5 | f504ab4683358daad2b6f9f3601b7699 |
|
BLAKE2b-256 | bc990c5d4e179c50a2e5db7e9f4f927c8baaa7ca9c5b65912f9a263f6a9cf6bc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.919-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52fb23be0233c73aabf7b52fa7ff9124efce68d3a709390b7aec98a102475fa2 |
|
MD5 | d811b44dd9ac4bafd448ce44b304ce9c |
|
BLAKE2b-256 | 73b6cc8cd146db8dfab3fbaf68a2179bbd3283606803cc90af69daf925af59fb |