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.269.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | dbbe9336ad2986651b1bd2bd66820decf963559fde8a0ed1eee4e6f7bbe50d8c |
|
MD5 | 84b43042000f2f3caacefbceeeb8f793 |
|
BLAKE2b-256 | bdc2626a903522988caa7876db5601b869f9385d08adb24bedbbd9f90c1b7dc9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.269-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5b279aefb1fac0cc874b97dc9382e1938dc372536fab0d2115c46c2794568fb |
|
MD5 | 23b45ccdd439f3a0fa1fbc6da4c479ef |
|
BLAKE2b-256 | 8412e0f9bba6ae28949c1247ea4ae4b5711587f5986fda59324ddf2217831e87 |