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.855.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e319ff10149a1c42cfc1585f0044dff23e0301b09cf2b446b8b257b693cf2348 |
|
MD5 | 17b035c0cc2cb819db92cb2f5c23f4eb |
|
BLAKE2b-256 | 34e450015c8be0100e86c8e5c13255596cf728dce18f10433cbeac053ced5736 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.855-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c5f2d33c1a8bec54eca0b8701f0f59095a0681176ca50a1560295f8c58ccecb |
|
MD5 | 3783774c701911febd8f8ad4becb28cd |
|
BLAKE2b-256 | e9a45a943664a57e8582acfa28e84470d19cd235be9d22838fc3507699d68b3c |