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.239.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f84ae6e4669603fde1a1b58138e7a3bc1da9fe745a0343b39b74b8b35d8a2d6d |
|
MD5 | ddabd26ad6bc0ce9bcfa3848af785f7c |
|
BLAKE2b-256 | 91328e09fbb92935aa600906267b85551c0a42f28aa4362c65ff71b0fb6d4fa7 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.239-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f86fe84898368bc690f2457442844cec42a36fb5586691b27597a7c4a7de7985 |
|
MD5 | 7b16964a55513d61d71cf6fcf85bf00a |
|
BLAKE2b-256 | 2b5b35507ab3f3781f82c133af0218f34464798c810d0a6d9e59e82fd6cc110e |