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.907.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad4cb47fd5c7ea0e7711422d289df7e2e9aedfec54fdcffbdc8925f4a2e3bed3 |
|
MD5 | 6ac82f631d1d77d77605fdbc83cbe962 |
|
BLAKE2b-256 | c511a1e51426da45866f1432ea38094d857076cf007437d48819f34348dde934 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.907-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | efa4b2fc6262bea2feeb592ae5fb96be18c34287d85e692bc9ebec5528e0def2 |
|
MD5 | 9fa66aec63d1eb56f45e8d8c9a28cce4 |
|
BLAKE2b-256 | 6ef335ffc83836d6ed7948bd2ef772b424007354596f732cb9e6f0fcdf449e2e |