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.291.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7540cf94d982356aaaec36fb927ec11a6e4ac14a747c3ff5b577a4e1071dd945 |
|
MD5 | 39c4ee9da11eab00967f8fc61ae98485 |
|
BLAKE2b-256 | ea17522db06be04591052a4feff4506693b10e34c17bd6bf60f048fdd179ac61 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.291-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 00a9c8143b9eef40dfe89dd91907801cb3b759bf6c2c6d09addc1a565396c157 |
|
MD5 | 8bdb3cabfe22a7efb1787be1ea77d853 |
|
BLAKE2b-256 | 2acc27aa28a26952754f97d18ad717ff6e9f60c3c2f5fc9b7531395fcd07dd89 |