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.328.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 78f0c1eb37656ea7bf7f5aa7d0ef9696c1c38480b094f6c33f3f68989168e5b0 |
|
MD5 | ed42a767b34d7a71028e3572480bf994 |
|
BLAKE2b-256 | 34abf561a1ed7c4fbc17afc0cd9e86a9324b213236b31b49c707eee76d2c907e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.328-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 600c7d70ff888c022b6d676ad7b356dc5abc29519439a2bf4458c218c9110f3e |
|
MD5 | b58bfa998f0114ef799337f09663b11d |
|
BLAKE2b-256 | 4a9fb0b28385e1b3bc91715ff605794dc7c4f09fc25c3298ff4ec8ea4112e6e5 |