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.782.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95093ade4c397decaf802a0d987f07d16924af84e3360ef228d134d03f7be6e0 |
|
MD5 | 3764d1ac711ae76444affcfcfd12b752 |
|
BLAKE2b-256 | 936e8c19a96b3ba5a4b11b5759c5bed683411c637a392616b97cfc030247579a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.782-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb77fddaf52bd40d2644dcdf29da54caaaa45962f98107a7eda4a56f28db0e17 |
|
MD5 | 48995b0349bdfd2d6a645b8bd85ab126 |
|
BLAKE2b-256 | d1d178abb8dbf15052070c0d7a2528640b8f6fa5cd356440fe214e830acc1104 |