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.229.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 130fc661ed9a9fce489f421ee94687be3e9c2ece4a05a2705fa372b8ecf194d5 |
|
MD5 | 054be35619cdea88d598c25a16abe61c |
|
BLAKE2b-256 | ad1d1ab77c383affcbc2e55571b32448aaba1625b1007d2879f4d2d139aa3e6b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.229-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a5d7f3f88e0ee376bc0cd5c865aeca3da843e12005ad1f761957849303b5be8 |
|
MD5 | b80aa80d94d597c4d49d749878ca911d |
|
BLAKE2b-256 | 70113a1deff51aa8aaeaae612a46044199e6b66d44d7b674a59e73c86c399e1b |