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.41.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d38afa6301ab82fa87197ec6e31ff3f661d325cae2272e764253a72bd481add7 |
|
MD5 | 6428f6d240a5831d41eedfbc51e90da5 |
|
BLAKE2b-256 | 2e4a49a56384e73226033f0d1f53fb3c4e92e07ecdaf8cebe74ad8cdbe462ccb |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.41-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 512bcae33dc81b5d3dec6b5bf9ee92a757509bcfd1fb9bf0b30018687c54f698 |
|
MD5 | b801cdea6c46a9a17439dbdb9d63026e |
|
BLAKE2b-256 | f4cb566b82897a104ff639a7fc55e2dfca833b94651b0621723135bde7f6f568 |