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.648.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e6e2db853a730a7b6a9304843a278d1d6172bbfc93268cfe52f5ceb0052ba490 |
|
MD5 | 154105a1d766f3b8d747b52f16fdc9d3 |
|
BLAKE2b-256 | 86dc21ea090943b9cccb48d0c556590075c4a3cc665ee7f494a9fd55f218ce3b |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.648-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ffce985d3114b26d01b2219840f7ca945a822a136c0d7e9a32fbbd59b44c77e1 |
|
MD5 | 7b179f2215fdd12aa751a25c2f838997 |
|
BLAKE2b-256 | 3c83000b68de6409a7d9d0cc99d4ce456184deea93f0f4c8bfb094d35a2f0623 |