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.880.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87daad2900e1825515d638c7750bf2f82fd24dc3e29dab09839587df953bd06d |
|
MD5 | 12f2d7c5b1fec5e961bdbd6186881741 |
|
BLAKE2b-256 | d780a81824ae955665bf6d26686d3244c7287285029ddf2b9fe2ed954aa90f81 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.880-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1efc39b4ed466eabfa3e0dee07e2454bcbed1a9452a85a86ee4fbb2cbcae27b |
|
MD5 | 570afba6bf4bd0c4f80385874fae3d93 |
|
BLAKE2b-256 | ecd6f3430190434864e6b8dbe1bd2632dc7f7fe0eb69f7e074f45ce7838a8530 |