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.841.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6fcc29724f47a189751fb1870bed737d67621cece6b56a3c2eae0d0071af0a4f |
|
MD5 | ac94df8bde093da732de2bd3fa7bcb70 |
|
BLAKE2b-256 | 424b53939c8cfe120f86e14ed6614fae149f760df326d4562ccd79813ae6354f |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.841-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a2b0ae2897575c278c49c8874c8b55163767b2cec961977490c28b913dedccfe |
|
MD5 | 0ae5380218cab4bc88a92872f6219db1 |
|
BLAKE2b-256 | cecc0046e0f07c31efadca0d97558461319552ba291bf536beba9952e7aa7a6c |