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.758.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3c9848b575c4e7ba0f80d4e288bd33639c6b6c56a5f2ab9bef9ede612ecd4f16 |
|
MD5 | afa14034e697706a501d914cc214b9cd |
|
BLAKE2b-256 | f3c9e7eee0cd7de1d64840652b4a0553b4e11fa7b26e109ad2cb780a95b4db29 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.758-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c73a94b7c0306fabe21982e0d6e4a209bce1b02b44f083bed0e90041e59bceb |
|
MD5 | 82214e2470db975bbb0a6d2432b04cea |
|
BLAKE2b-256 | 7d66212a5e17f3f3125252d64e84ed687fe370724bba1703bd29b062bb5a0c62 |