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.929.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 35fa15b5bb33b04125d048270107dcdb0ffff1a911776e2b1710c04ed9887ac2 |
|
MD5 | ee9b203cae718769e0fbc0c753140729 |
|
BLAKE2b-256 | a491a2a041faf335e1c7ee850b28e5a4c7745bdfa23bd49eacaa2d60f774c671 |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.929-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f83366509c80ee9a0bea1124fd4af1cc8338a44b06b6906d68fb24dc661f1268 |
|
MD5 | f9f39212226ecad780e4882a9ebd8da5 |
|
BLAKE2b-256 | 362b4684d266723d24b65a531227c3bc778125b3b939151c6b5212f06bed7296 |