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.285.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 604074248e456efdf1b9a9d1947e711808124c4c68e58ca56055a3317a9ebd92 |
|
MD5 | 46542e1d4b642f9359a41a2f16e67377 |
|
BLAKE2b-256 | fa09667fd49a47ecbd024724256643ace495380c2c53315cf6b3bb70b039ceca |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.285-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e10ade2b6348332668c9e1aec9c04a5f4e87267901dbb5dfcd982abb6eddeb91 |
|
MD5 | 1e665854ada23b67b9d7e60f29829436 |
|
BLAKE2b-256 | 11c64ebe458c7203f50208de7e08aa784482f5fd12a8753bb1e00b6ac51f57a4 |