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.735.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16c49d802554d61ff232fe9f60b9cd430171e198f6a85d3c44d11782ce721fd6 |
|
MD5 | b91fcb49c4cf77e0e22bfd59d33720b7 |
|
BLAKE2b-256 | aeafed0ce9b528fed361e0d357e68bfe1979204912feba261d7b0c9c58d2c4c8 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.735-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc14c13f5c79a69da8d4ccb58e18045d6444d26a9a1c761e9ffa68c6473501d5 |
|
MD5 | 16dcb2b38ec89ecbf7500efe64fb682a |
|
BLAKE2b-256 | 6e1734069cff9ae64c3183b13d66d5276a61d88d1db7827609ca709a7b535320 |