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.850.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | db804dc1bbbea1627dd82a56e88952511bfab131697d651e825ffda6bcf52ad8 |
|
MD5 | f951f9dbd39f2245c82cb470b7cd3a54 |
|
BLAKE2b-256 | 4aac0c05980360a1156818efa92131741c775ff45e9b03c7ae5442d597280a3c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.850-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d7552c32fd0a46ca2fe92cf517020977dc842546ccec90915b3f94e3817093f |
|
MD5 | 11cd4db719f4d3a43826014ea619dc6f |
|
BLAKE2b-256 | 716d312fc3f635170c51f1d3349e3236ffa989f5859f8fa0ac58ab7fe6b0af45 |