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.80.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d28ed441717a63216d859cc116f0714dee86a6040b629edc2172d6396b1aaf7b |
|
MD5 | a4dee1ac152f2c213caa3d28f5bf751f |
|
BLAKE2b-256 | 29e47d43c1c0235a172ca0bfc921b90cec8205aeed00b479f46422a13fc79e5e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.80-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e6fe79eb5100cb38aaeb1250cb7fdc4d907f250af6f6e4c5032268ac8020990 |
|
MD5 | 5738876fe0ac0e559f539f8646a45cd8 |
|
BLAKE2b-256 | a8ff1c4c4592c0e51e8e1de04a542ff332e138beb11f1534599bd38725ad3984 |