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.29.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3467410d94ad3a16a3c1214e864b770f89367365930345efbf730baeb089845d |
|
MD5 | d5673705bc85b0aea6f38a1f8df0700e |
|
BLAKE2b-256 | b5ddbececa0d34da54ca4dc4d88e82e7edd879b24861b8e7453f0f66744183dc |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.29-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3bec488c433ee8436829b8ac637408603eee35b349ab8f10325c04f67b38f906 |
|
MD5 | 1b59b52f5c2692ce81fdc551a73f0104 |
|
BLAKE2b-256 | 517a450704aa03544aaf64894c166d4284d979a2efee37bf4e06dcbdc40a214f |