visulimaVisulima Api platform
Visulima api platform is built on top of OpenAPI (Swagger) specification, node-rate-limiter-flexible, @visulima/connect With a more intuitive API for creating HTTP API endpoints.
Daniel Bannert's open source work is supported by the community on GitHub Sponsors
Features
Installation
Npm
npm install @visulima/api-platform zodInstallation for Next.js
npm install @visulima/api-platform zod @visulima/fsYarn
yarn add @visulima/api-platform zodInstallation for Next.js
yarn add @visulima/api-platform zod @visulima/fsPnpm
pnpm add @visulima/api-platform zodInstallation for Next.js
pnpm add @visulima/api-platform zod @visulima/fsTo use the swagger-ui or the redoc-ui you need to install the following packages:
npm install swagger-ui-reactTo have a styled version of the swagger-ui you need to add the following css to your project:
import "swagger-ui-react/swagger-ui.css";Note: For
next.jsyou can add it to your_app.tsxfile
Or
npm install redocUsage
CLI:
To use the CLI, you need to install this missing packages:
npm install cli-progress commander chalkyarn add cli-progress commander chalkpnpm add cli-progress commander chalkThen you can use the CLI like this:
// Shows the help with all available commands
pnpm api-platform --helpconnect
This package has an extended version of the @visulima/connect package.
That means you can use all the features of the @visulima/connect package, in addition to the features of this package.
// pages/api/hello.js
import type { NextApiRequest, NextApiResponse } from "next";
import { createNodeRouter } from "@visulima/api-platform";
import cors from "cors";
// Default Req and Res are IncomingMessage and ServerResponse
// You may want to pass in NextApiRequest and NextApiResponse
const router = createNodeRouter<NextApiRequest, NextApiResponse>();
router.get((req, res) => {
res.send("Hello world");
});
export default router.nodeHandler();Supported Node.js Versions
Libraries in this ecosystem make the best effort to track Node.js’ release schedule. Here’s a post on why we think this is important.
Contributing
If you would like to help take a look at the list of issues and check our Contributing guild.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Credits
License
The visulima api-platform is open-sourced software licensed under the MIT