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.84.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7815173f7956ba70c9eda1393aa940dfbf861e43d7818f73f17de2decc46785d |
|
MD5 | bfdba1c2650cba2161e5c8b4f778f4ee |
|
BLAKE2b-256 | 11dd7c03557d54a6520dcf820a1977e5d9a5992684ab97d5ced4afe063307862 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.84-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | feddd3106612a3e1d09ae1b348475f659cb5e15b2c442dc6e15ce42e04f14c7e |
|
MD5 | b969d6877f1371f56ecc5a6fd119ed96 |
|
BLAKE2b-256 | db4a7f993a64a68c1a79188faf2375793e7552886d868dde7da8fe88a5b687f1 |