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.463.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ea1e839599e9e3a2c575a86549a7e4e1868124e6faea47145f58445decfee745 |
|
MD5 | 9e72200fac41f15a1a0d77ae808da050 |
|
BLAKE2b-256 | 5320cc62422106b92727f0e5321f103548aa2f3e74bf825951433022be26ba6e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.463-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d78fbc299706f33e96066cbf54e9a82bf5f372563b5de07d13e3c62a9fdc2331 |
|
MD5 | 80414ac78b77a724ba43f510cf36e9aa |
|
BLAKE2b-256 | 0e3660ee6c3245d712763f44d79287483b5e111184e1f396a3ebd242305986a2 |