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.63.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f251419f71459215683e3e2f0eb3a478a3300dc164ba9b7448103138a2936be5 |
|
MD5 | a9326fc566508c5a21f8abf6cec9a86e |
|
BLAKE2b-256 | e401df9a462e37a5bc18a96b1ccb82703a68eb7bd8bfd79ff72c18322f6f023f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.63-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 692c20b8d993b6827c41f3deb560ff2e322468928df0e62de6bedb03f18bbf44 |
|
MD5 | bfe221a33ddb63fb050b768e9c100d4a |
|
BLAKE2b-256 | db7b8f87dec9c4168953aa57ad61ccc3b9bdec853e70a9e79b3fef920cc27626 |