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.711.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 63fcc1254add6612a2bb4999f0ba9e29b24bde7aac1f405047578a1c3b8f2339 |
|
MD5 | ca612b8ae4f2cd313838956a04ccf034 |
|
BLAKE2b-256 | de84495fd5d5856f4944dff243555d93abcdd70223f65d674c2bd6219b84562a |
Close
Hashes for pepperize.cdk_apigateway_swagger_ui-0.0.711-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e4f02a1519fafa2cd37e10dfe8594d835ae86719c7322b5305a4b12d800c39a5 |
|
MD5 | 569e3c58c69d235468f1784738af4468 |
|
BLAKE2b-256 | 4abafb493da623f2233f5792c66f34d298b56f4f035877dc8d4a13e534959512 |