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.62.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca63c81dfd192af7281311139d9a5bfe535f7e9606acf7934a4fc8397d71412b |
|
MD5 | 2a1afac56942018d145962008a254af9 |
|
BLAKE2b-256 | 9defaf6fb42f045f365da521aa867468dda6b6507ae395c2b7afcaac5dcb4f73 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.62-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b176c10481c757f63703c9f1238b422d5d7b050978b6d998a632af62f98b41b |
|
MD5 | 8f2916f572e8955997aa06205dc23eec |
|
BLAKE2b-256 | f36cafd7bd9e92165839bed9a6cbecc7e24451cf71e4eecc35055b91b4ee3626 |