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.156.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4635f2b212243eebf2f570a3d855a3d644da86d95a251d46cd8db71676355b8a |
|
MD5 | 29f5b14f235ac45b31baf7b2d3d26ad5 |
|
BLAKE2b-256 | 7d3addda3ed61cdb4f2857462d5193dbef3f5324b5f843e8d6eb9403eccf8911 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.156-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31aaf1d6ce705485c80f0dac74ac0e595c4d0a8176cb077266bba2092e76fd70 |
|
MD5 | e56edbdea2234ef47b7c2690f6a83569 |
|
BLAKE2b-256 | c16d28a910f7697a556dbe87fe03054f86d85dd9ef32d6d9007680c9c422b3c1 |