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.425.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 11e0137e0c013c5bcd4237b786a146ef60c2320f72204948e96ada477129dc94 |
|
MD5 | 30598999f0dc1dee45412392b78d12e4 |
|
BLAKE2b-256 | 7eef6d1ec67e81392d213089fd33dbdbf2368e39e3bbcd9c8ea27f993ed50b32 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.425-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed7ed3a4952af4bc1fde9e0511af33d0f5df56ece5428fbccb1db373a4f62fb7 |
|
MD5 | 19e4cc72cbafe3ba51fc404c2196da5e |
|
BLAKE2b-256 | 3cd7d357cf4475ba1d217842d49517468103ef72e5fc4320c2edb51fa76db47c |