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.205.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9f1403162e79aef51c8eb4376fb7ba6c8217b27ef9285fdbbd800304cabe1dc |
|
MD5 | 23fe2015fe3d42752aeb10e39b7cd81d |
|
BLAKE2b-256 | 88a78cdaa378ff64aab4befecd516487c8002872acb44ba55c1097bd7731aecd |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.205-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a5a92ee807c08acf2d90c9a2d2132ef7502c2af2e82ff230617c296826cdd98c |
|
MD5 | 0cac829099418e74e1f157fd6905dcf1 |
|
BLAKE2b-256 | a85db50e49260cf5008f4d6bbe47b1b6a90d2d3a28a6c361b3178aff396bc91a |