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.409.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8175585a424d8ea2f79a3ce334f5f44fbf65a74088550f5de1213c581c0a2c5b |
|
MD5 | df7c4667d51dbcec669e9a63500ccc6c |
|
BLAKE2b-256 | 0e14f83d09c6ddae5b5375fdf9fc2f0aa2e4d940506e86bc709c9574dd95f3db |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.409-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 56fdd45a7d384b37122f84cb1155ecb4af209f6c0e03748db23e06c4c2321ed4 |
|
MD5 | 9f0f759f891f5017028a9b271da87dda |
|
BLAKE2b-256 | 4d64df0d2159159dbf1a64c70e9ff1f3626ef5efefa4191968d712c28451c279 |