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.183.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2cb06dc6f031df8c34e4ca596c352d9347a07204b07ee5679a9b68f7bf9e3f9 |
|
MD5 | 2f9a24470ff74479df554a1779ee4c33 |
|
BLAKE2b-256 | 5757fb7412fe6aaff9359d2d7a69ed8a3c09e5c51348f1b1c89f47cbf6c4ada1 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.183-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb56c58a5b0c93a5d5751add417b584445944e8328e60ee3677ee3aae46ae20b |
|
MD5 | a0e72e8314f956b6ad6e01a5f9288bba |
|
BLAKE2b-256 | e46cc393f3f01ada68f2e1b3c14b5429bc28650c1462a8163799689d8d75f552 |