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.503.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc9d36f58155e0b0106904682d497652967606475c1e3e5529bb0df8bc805637 |
|
MD5 | 30152c0a1508255820f116a1ee04f1c5 |
|
BLAKE2b-256 | 3dd15bcc41b8bab09e2027bc9f257f7974198cfa4ae60c25bc70559b9d7d7d60 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.503-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2194f8bd9e777530b6269dec41a2bb6c459ecb23910346949c2b45f6ef7fcf1c |
|
MD5 | 90db0d0391e0ea02881959eb25e90b03 |
|
BLAKE2b-256 | 974b0020c3a3fda7782a1641d47b10e6c02be995a1c8e6fbaf95336eb59fef15 |