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.365.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fb7ea4525f10faae347d104489649ab07267c8f867a064583a12e4006e5cc1c |
|
MD5 | ca0dab57bae43a5edc28866f00a05258 |
|
BLAKE2b-256 | 4eaed76d03fa39c49c499f9700541b21420cb17d963e8db0b95f766c002a9fd9 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.365-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b33f30e080a76ccbd9d4d04cdefadeb42ff76b1e39c03c0281efb847a4154620 |
|
MD5 | ef59b44685a23d5f4adc976ce8583ae7 |
|
BLAKE2b-256 | ce949f23c9cfa88e8b17d20804a2e9ecd30f7ba1fb5457663695d2854dbace58 |