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.322.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bc9a8943fa8d215eb0881d3d7330d380a7b0f7afe966961d1a691662aac4f225 |
|
MD5 | 00e278577a6f6553d2a8defb99d6fa99 |
|
BLAKE2b-256 | eddd1e0c52c149227f261576ac1be02df8ae4e150379edef223562b6db59ac2b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.322-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a64b7c2652cb6e25ba4f6b030e9ec634ff1f65bb020cb525886426c5afd45780 |
|
MD5 | e4cd22e08154d770d00f2bb84b4179ef |
|
BLAKE2b-256 | 64b791282a23fcd236c94a14b954de0ca650516152840fc2c0b9220984764d5c |