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.83.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa6b300059718b0f3cf6f7d439fe390f1c68f32e9751b42febe212f6793e81ad |
|
MD5 | 594620e4526ab651cd4003f5a0bb0e02 |
|
BLAKE2b-256 | 815012630bb81f570632cab77765fe2b99410411c452cf4e689a14ae8070b744 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.83-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ebb9d439767311401c662f925d340f55fc5f2cd2329b10a9ff7b4ad1d5ee1be0 |
|
MD5 | 335e995708be4e8be28a8bda3c5c962b |
|
BLAKE2b-256 | 4faaba308821f46572e9c65cd3dacf17004f597a3d054583376f579a722a2a51 |