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.607.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cfd7233aae0c23439bcea45620692b2c631e8af654549e0aac0e1d78462079e3 |
|
MD5 | 38cbfc906fff7f95ae95e936ff16f0f3 |
|
BLAKE2b-256 | bf2a4d6ef0edf7183cf4e6925515e8a8a54dee01005d4bb0b71e0ac3bde0271e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.607-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2da20a483a40b5113b725b9a80e2516ecb1263b00154e8f96d0d4f0f08952dbc |
|
MD5 | 521dfd87e6f63a0de5eccbf2be9dad10 |
|
BLAKE2b-256 | 91c725e3fed7a967d496b29cd71e0897055709da208da3667bfd3bd8402e60ea |