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.311.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 897f5a7ee76004b92be6db0361558fbc4674daa571500ff30bb8e4ac57b53b5c |
|
MD5 | 33055c008d54468175bc25b5ed9fb7ff |
|
BLAKE2b-256 | e1d611d4ca1e988ea9c5e4101b9c291effb3585f57dbb9ac935583e9c6fd2b58 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.311-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6ea91a8eb52aa545a157a4ced61c40f551b95df8100357af3337ba9fb98a8956 |
|
MD5 | de28b4575db804f15e8784f09f00b19b |
|
BLAKE2b-256 | dea123dd324f8663b57e6a602efd6e548588fc449c4751258bfb51159c97744f |