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.778.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f18867f792dd05d3af5f0547821bc10b2ab811b219db4ac438e8a5bbdf8765a5 |
|
MD5 | f948391f8b8a6ef24d6286e019effe9f |
|
BLAKE2b-256 | ab9a6a5e5667fb47d6a4df07fc2f362410b680aaf72a21a928e2275a694e1cca |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.778-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55e36be3c826455f2cb63d11c4112584062c065c56093c656f6d6be446b962c9 |
|
MD5 | 86720e6b0ed3283bd675e071610b1414 |
|
BLAKE2b-256 | 393d39e59a1e5f661643ac05cfe4ebd80dcdd636c333a99eaf20f53b5d0e1858 |