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.388.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b2fad5eb39d54367ba48db5e38ac40e09c4a176ae26aed74e1fd34aebb708220 |
|
MD5 | f85eb7628e289aaace93efc1559c97a3 |
|
BLAKE2b-256 | 9b0b1eea1486304f615106f9213abf132ade937d51d13ed3e84b4421f1b40328 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.388-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e51eeb74ca371f2109b6e52fe8c290e3a3571a426033002df990ebd9b4e3b90 |
|
MD5 | 07c72f6f8e0108b772ca2c9ab2cf0689 |
|
BLAKE2b-256 | fe479ae1cb8e946ec42f099b629f39c202ac7379a99228b466af98ce49842431 |