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.804.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | abee1e9648f1010cdd4369ef39ac4f027504fcc413cd246e94e3d922c6577fa2 |
|
MD5 | 120bcd5fdcc9b99fe00c09a5bff15b35 |
|
BLAKE2b-256 | 6f24dcb61a2ffd098d81407c5f3c19112e992b0f8bfcc50931ecbe7fe24c5854 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.804-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7b642f8c9384f847af28210cd7f6e3935934c8783ac7fa1b0e3fc9a1f109a23f |
|
MD5 | 8d6be61484574146e9fbcb5f8d279488 |
|
BLAKE2b-256 | 20a0a381c77bbcd9cb1f7c85a5c1691ba5c9e1cbb1281b28cbcdd9dc0ce8ea61 |