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.535.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bdc3975bd0376e2274e35ecda957dcd4453be6b0469b37f5e25e9edfdc4c757 |
|
MD5 | 13f4aaef24192ed781a2a4516e93956d |
|
BLAKE2b-256 | 5c9c98cc1ce939432b1cf3f0c90e80e9a10779e6f0a75973e02d7691eeecb734 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.535-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b6192a77aa29fbbabb9a8c8b807e0ceb11bc73f6ec0d13190d3579c7310b8a0 |
|
MD5 | b1b243dceed790f21d41e14184c01061 |
|
BLAKE2b-256 | a2f44e6abf97ba1dda9188d24d736c953cb0409e77893d4f427a490023ce61bf |