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.694.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5223984f37d1999545a83ebc71d870af33774f4ad095a0d12a182680734b4b8c |
|
MD5 | a76ccb75f3730ee43590699420d8fa26 |
|
BLAKE2b-256 | c51a1032f04a587e74f464dd64da01a01721e13bb10919f5a0cc0f8cf804bc0d |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.694-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3755cb368de40d4f17446a135b530ccc1963063fabc20669d0f9d43a2a81d02 |
|
MD5 | 3b0aa6a306dee2e0dd2482bfcaab615f |
|
BLAKE2b-256 | b4f2d40605f9c029e58764971f343ab5cff7ae1fb96204ef45be333578cecc02 |