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.877.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3117ccc9679931cad650676cc46c64c67824c7b96d9ee4f2277f2721f7e698d2 |
|
MD5 | 9a8f0b2057e4e347fb7b4ebf066891cd |
|
BLAKE2b-256 | c32029a4208a02dc2ec4ab3bf4f73f73a221dbf30db36179ea17fc71330e9440 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.877-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 79a9cb39468b223f1bd14b3aeafd320646e23dc6fdceae232286af7ebf85e322 |
|
MD5 | eb8d19ab3315b18d1a79466284b4b591 |
|
BLAKE2b-256 | 6411fcc5a2aa84c34321184c0a704690276c8453f6cc5c43003b6551d3acd9c6 |