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.646.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 90e6e88a3c3e882d565cc46a1c62ab771619b10644585de3e79cef8e2ed3edb0 |
|
MD5 | 465019495332304b169dbffdc1f8efd6 |
|
BLAKE2b-256 | 192c91a6fff1107f2a491f40408e7c20f1971e5da42e848629d841996ae6c41c |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.646-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa7ecf46cf48ca8d0db907374d6e0fdf64fe684ca9fa8a90daaa0b6e895b1b80 |
|
MD5 | aa7d95f33455bced27bb17eaf6a51732 |
|
BLAKE2b-256 | 81573d498aae623cee1e4e256c941ae96f7ed8abb2204258df51b7259e38c962 |