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.575.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8da06e0008bc690ab14d815a4da33eef67ab2a06eeab14a21c85c9f24893f484 |
|
MD5 | 5b82a969a0d21beddd946f5c156a7f3a |
|
BLAKE2b-256 | 3718a60e65b87260853915257c543895f5e1db84681376f87dbac4f1911d9628 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.575-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c8219354a59035f8b70e5a2406747890c8fed6f720366b7d4c39b1b1c1287d1 |
|
MD5 | 439f12b22143f312e297aa68ac720fbb |
|
BLAKE2b-256 | 24d0d5c73dab0a86c279c8ebec894e8ad3ffbef856656f6826581243f5c60a8d |