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.113.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8af3ca4c4a50ff222f15ead3aee83201a49ddddbafd5c3ef2de52744a1c9e9a7 |
|
MD5 | dfda25cf6246b6e83b439af9788418e5 |
|
BLAKE2b-256 | 9525d23cfcdc50c551aec6ed37a9f89c752e037ffc2bd004984699c93413f6bb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.113-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e563c2661a344ae73f237525fb520f772fce3293e92682bcd2cff7ca8ed78279 |
|
MD5 | 363dc91c66da5ffcca316a2fcbcbfea1 |
|
BLAKE2b-256 | 588cfec055dfc5ea62e451dd107a3e7bab2ed67288d72c0d90275b87c42719b1 |