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.884.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82a60515f0667670369c50caed5e9387ac67e5a4b09dcd0164ddb4e6b203e25e |
|
MD5 | a921f484a4a2a7533f4c9f66bbf14c2c |
|
BLAKE2b-256 | b1dee8385a6ed148eec1177a9269f265b9cde7a57a9332bd91a84d9a08734057 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.884-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52c13ef5e4db5ac4042c46dfbaa8ba1552d54da37ea2d70465de80022cd06901 |
|
MD5 | ce130e2721ece16c863104d4e86887ef |
|
BLAKE2b-256 | c8f151a970d30e333db7ce9121940dc29e50f1cf4633685683ec3669917b447a |