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.276.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 014a26e5cd2ee600861e61004635ec8426aa077e5de6c3ad322ad9bd1baab68b |
|
MD5 | d3a528066103087d30ab31024631192d |
|
BLAKE2b-256 | 4268833ea6317a484684d4067cfb72fd694d62be5f3a5b311a8110ba66ba0621 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.276-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3554db196acfbef7feb6c123ae126708292c772ca94da64841b07dab104e4a49 |
|
MD5 | 80a2b5fc0d5ffafa139fcf1aa1959436 |
|
BLAKE2b-256 | a4947174edd52fdeef9774c77acf9cb073791a8522476077965ed60f8929faf9 |