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.479.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9a7123d9a81a60e0bb324d9b05f29deac0afffc46a887277e1cf7e4be928405 |
|
MD5 | c22b8260b51158c92f256f9e23bed42a |
|
BLAKE2b-256 | e073a795a4476ce719e40a047b9192888da285c2af60825e40260a77e2c5505a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.479-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a0aae9b56ebfd94437a6e2fe2b1ba87360687322bf0792176588232b16a3ebf |
|
MD5 | c3fb8c128353737c9dcf66f2a076ed1d |
|
BLAKE2b-256 | 5c6867653afaa0d4226088d6f13a666ed671585d8a02abdc51983e2c285e0e75 |