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.706.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2657b1f1e5b1239051c76b80b0112cef48541e5298c51fd7fc3525bb7370e6d |
|
MD5 | 6cfe33270346437852d4ef83193cf88b |
|
BLAKE2b-256 | a6272c6f1b82e580af10ebdacbdf355fcad545bb23ab4ce1c90a52d6d4980b0f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.706-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0ec076cbd4528e0c70bbbe1d519bf901de552a5cbc3bfeaff7094cc6a991d68 |
|
MD5 | e72625bd08f29b9b8ebc783883ef188c |
|
BLAKE2b-256 | 40d05306fd30ccc7d847b167a98eeea63921f1a7668d178ef495d6329546cb26 |