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.338.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64eb2ef094be2360813de2fd41e9b232aa97152d5e57c1af6dd6d9db3b146422 |
|
MD5 | e75475efce3416f7865178db059fb94f |
|
BLAKE2b-256 | 47786ad0c861b569a355598fae8a28ebbf467a4365d1f358858b77163ace29a2 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.338-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0f7856eb1e2705770544a207ea10df5213a30cbb96c6942b565012eae88b3e8 |
|
MD5 | 8b62aeebc80e4f697023b4cf750dfde9 |
|
BLAKE2b-256 | 7d0c560aecc491e49bf7b107c258e1b02ded865cdcbf7e68188206e519427435 |