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.507.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | addc9b36daef7d799035e16b1213518bfdeedb2b6d14253607f68e56d02e8fb7 |
|
MD5 | 6d0a6b5a9f1bdfe045704aa5498af43a |
|
BLAKE2b-256 | 04cf10c0834183e99e863472b8f8b78cee177f5d0d4a9e87d50c8e703e32b2d5 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.507-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 689062061ac2946a324ed6f9fb696efaaecc02edf6a6c21d1ad8c6ab841317fc |
|
MD5 | b332f1d20b65026528cd342fdc3b7236 |
|
BLAKE2b-256 | 91fde5c0d35272847501d82fc7aeb76beb11addb19511ac38f07e80093d815d9 |