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.544.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed4375faec9cb4796f61c29c03499e38f604ccec815d8727dae422b97ca06e6a |
|
MD5 | b098ba6a5ff5a108522037f7252c0d1f |
|
BLAKE2b-256 | e6b9233aed71f678278d2c50e6573604e55886ae2702cc5a62d7ccae43c6176c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.544-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 523964ea6388eda1b2e3213e0324df531e8d247765af6dd302d2453bda6a8a11 |
|
MD5 | 3dd18c408afae7e1427330abb9fd9563 |
|
BLAKE2b-256 | 33d4f29e9270a275295e6a43c89823a4ecdba1ff3309bf59fd89b2d92af0ae84 |