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.104.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b9cbc8d9d8c20a4ddd843f23d5c2ad1e165f43b25d55a98a80dec99629d100f |
|
MD5 | d949473376422610fdca2510e09d69d7 |
|
BLAKE2b-256 | aed434325008205fc83466eb11d4efe86d24928a79d0559d4281267dc0b0016f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.104-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9a5b428e81f0311276dbaabea4bfec2a17aa070cca7a30b5740236b407874651 |
|
MD5 | 093b21070d577046b039ba4a2fca591e |
|
BLAKE2b-256 | fa8386aa26c4bbcfccc8bec41285f15e0b771f79068dc877e51fec9411aed82a |