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.498.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9e9524ec3a03a90fd143d20969982014adce9c8aeb09b06d4b605378d0d8c44 |
|
MD5 | db94455d89169b421c2d6d8815ef0052 |
|
BLAKE2b-256 | da116b9bc76717c82f86c8a7a88591d91e917facf05e387f938e642f1dfc000e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.498-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5706aa6ca0dc77bec4779080175b23c3a83d9982e62432e6797c4faebc46ba09 |
|
MD5 | 716b30a30f538104f81438a143c97fd5 |
|
BLAKE2b-256 | 9760c4a781241cd4079092e2b2b2aba0bf817be5c20947f3ddd97b4fef7a34d2 |