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.225.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b40f8b32297e16a0fdda48fa21330c1a299ad1b917de1fbbde82218cef55dbb7 |
|
MD5 | 62d3be06cc5b58d8a6d6c9c57a80b409 |
|
BLAKE2b-256 | a5773aed7bb81665a5f7872d8a922511f2dc8eb20cdabb8f05b94d7a0ea3e196 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.225-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b6809086662e4d5fec0cf7e4d0b347ec31f9a71c20e1a250104316a3ec2942e |
|
MD5 | 0c864456d84397e287331aa489a5a2fa |
|
BLAKE2b-256 | 50d49f5637bb9e74d5eeee3d48d720ace99741a1339f3e87511b8d16b61f122c |