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.366.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6482c5be8dadebb89554af39eafad698acae7b37053ccc70088f45c2a4ca50d3 |
|
MD5 | 02f73a6cb83b71f18627fc211e44f583 |
|
BLAKE2b-256 | fbebbcea3f13f9ee1b88d4849651a549b165c0fe4c608a61e626822b48b94412 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.366-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bf6ec00d649a4fa6b0272332b84782099702f82055b6f3b18cac26979faea71 |
|
MD5 | 4b144355e246e73bac79126f090d95d8 |
|
BLAKE2b-256 | 57ee64cd8588c44b5d03ab1c2f83b2c8ff19cef77be5dbed0ee5b8073fb13970 |