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.30.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9baebb0621b0db8033cc4391ee009b3c9601e9bfaba8ca6c2bebd43633d8ee5d |
|
MD5 | 66d47759823c7c256406a0df7a456041 |
|
BLAKE2b-256 | 17362ea6874ee39df3755fe250f60f9ad611341b9f2bf58ff121aa3240afa44c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.30-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | febbeb9b3bc293352d68e976eff0a97f4aa70207a77089b10698d9273928e36e |
|
MD5 | 17d3f4fd22ccfd20feb59d612701f8f9 |
|
BLAKE2b-256 | df79a9f3f35d44317804dde50f2fa4647eda4a35a510f7497172b6184c73f909 |