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.31.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63ce76a6fc619d06b58e8ed04860a517816fa0242594447b807ca16176333576 |
|
MD5 | 8d95380030ea5c295a72d564ef628146 |
|
BLAKE2b-256 | b9c3b96cb135dc9ad83f3609447e247173b7ed282347f76f8bcc94e55c4ce274 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.31-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22d7141ce5267ae47ffc46700c2e04190ab5d98e9043b59f3da8b5a7cfdd2c3c |
|
MD5 | cd709d85d25f4a1978fdbaeac8d9d42f |
|
BLAKE2b-256 | 644204de793710da8dd1f78b108bfcef3ae5f3bc5e2b130045241b6f838255d1 |