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.166.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b5abb95abc181a9c4e7425d1349345a8a48f31b6d6542e65c850d1d700b934e |
|
MD5 | f26b9dc1bf017848e1f9e3180e8bdefc |
|
BLAKE2b-256 | 0bf2b29353f891be7b20823361602041dbbbf0d7a11ccbf57f8aa2f4d532ed02 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.166-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf92ea12e2e9b5720af9ad231c3b1cf1d3ab863d2a0ecf562299e7e3039c0e19 |
|
MD5 | 64a069d98d2b72e773af630978d99cfb |
|
BLAKE2b-256 | 74f8b1067a1af5bc3bfa1ea99d60530f1fc12ef7ed6892ca0f9151632bfa83ac |