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.335.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d07e78d776490ebb17f2f4cedc73fe124a8a58f56f48da68eb695ba3764fe737 |
|
MD5 | 3b1470c815d0d0b5ac15c21857fa764a |
|
BLAKE2b-256 | 10d58cee99812371b1d9d275a410ff08f5f53eb1e9eb08288227a98e6b129012 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.335-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6b0930d4cb61ebd98bfe386d867f554238ec2f119461a2d652584d27d29177aa |
|
MD5 | 1867c9e5a0c81b029fbc1cb5c7c835fb |
|
BLAKE2b-256 | 45989f4bbe3f34d0bd315d38757a0d3a2d68d1eafdd3fb06ab88bc5865736c86 |