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.78.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1b4abae6d8b4e7c6e2896b9f50213563c1ab84cd682cb73a671ee92c068e9abf |
|
MD5 | 8f344269c41e59248a45390ae281bcaa |
|
BLAKE2b-256 | 4e06da67cf79b7da73e92ac400f303c17687ff9013e9dbae789bc612c9ce177e |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.78-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65ad2cf086fc762c67eb97d760fcdcc81fb5c7a9016c03e1820c501a4647f191 |
|
MD5 | 4480e9bac0c1a919b829ab9afb0f6f80 |
|
BLAKE2b-256 | 80e13d5aa33c1e56530581feb62773ec3b92a2338e3a8c79b8b5a5d8517105f4 |