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.559.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 278464acab8311f1f5239ad037dcd5dc260a23c82e6e704236eea8d799b882d2 |
|
MD5 | d3ccbd4cb173773bf2a9a1ad80f209cc |
|
BLAKE2b-256 | 3af09a2e2d3c34c695c59980e012517aa708dac6f32439dedc365c11d306b3f4 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.559-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 61725266fd6d67331bd7984da081c36b96c608b74a8288efad1d13d8d89c1cee |
|
MD5 | 1190564c8a83a6fffbcbe4e42a34ca76 |
|
BLAKE2b-256 | 6e30b8ee61dd1677290f0c628672a27cd84995cd48dd0efe39c047a552f38c3f |