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.87.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7466e7d08133c303624b819a1ac4fb3430c6f1afed8e7ac12eeb0038923d5f9 |
|
MD5 | 8be9af4ad5693a0d53a8689e6e617458 |
|
BLAKE2b-256 | 4bff2cf9cd3a7c3b348dbdcab06e173ba88e674fb33a5ca971f7289fc7274de6 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.87-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bb164c3f0a87e3c900f07b4bc6f97cc21ab27877e891bc7dab9f402f3dfe6fab |
|
MD5 | 8905c6f079f8bb156a50284470ea9908 |
|
BLAKE2b-256 | 723ca61de3677e362c09da323508895e95db5db70d3f6b7ae237eac21805a772 |