Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiowenluke/noapi
A high performance API framework for Node.js, load directory "biz" as a web API server
https://github.com/hiowenluke/noapi
Last synced: about 2 months ago
JSON representation
A high performance API framework for Node.js, load directory "biz" as a web API server
- Host: GitHub
- URL: https://github.com/hiowenluke/noapi
- Owner: hiowenluke
- License: mit
- Created: 2019-07-08T04:29:55.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-02-10T18:27:20.000Z (over 4 years ago)
- Last Synced: 2024-07-22T05:33:27.958Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 5.6 MB
- Stars: 104
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Noapi
A high-performance and easy-to-use web API framework for [Node.js](https://nodejs.org). Noapi loads directory "biz" as a web API server, each file in it defines and handles an API, so that you can focus on writing business function code. Noapi is simple enough that you just take it "out of the box".
## Install
```sh
npm install noapi --save
```
## TRY IT! (in under 3 minutes)
### 0. Initialize a demo project
```sh
mkdir ./noapi-demo && cd ./noapi-demo
npm init -y
npm install noapi --save
```
Create the core directory "**biz**"
```sh
mkdir biz
```
### 1. Create a biz file
Create file "./biz/say/hi.js". It defines an api "/say/hi" and handles it.
```js
module.exports = async (name, age) => {
return {msg: `Hi, I am ${name}, ${age} years old.`};
};
```
### 2. Create index.js
```js
require('noapi')();
```
### 3. Run
```sh
node index.js
Server default is listening on port 3000
```
Visit the url [http://localhost:3000/say/hi?age=100&name=owen]() to see the result:
```json
{
"success": true,
"data": {
"msg": "Hi, I am owen, 100 years old."
}
}
```
The order of the parameters in the url can be arbitrary.
## Examples
* [01 hello world](./examples/01-hello-world)
* [02 complex url params](./examples/02-complex-url-params)
* [03 returning an error](./examples/03-returning-an-error)
* [04 throwing an error](./examples/04-throwing-an-error)
* [05 api directory](./examples/05-api-directory)
* [06 with database](./examples/06-with-database)
* [07 static resources](./examples/07-static-resources)
* [99 options](./examples/99-options)
## Options
It can be omitted if it is the default value as below.
```js
const name = 'default';
const dir = './biz';
const host = 'localhost';
const port = 3000;
const isSilence = false;
// The number and order of parameters can be arbitrary
noapi(name, dir, host, port, isSilence);
// It is equivalents to:
// const options = {
// name: 'default',
// dir: './biz',
// host: 'localhost',
// port: 3000,
// isSilence: true,
// };
//
// noapi(options);
```
See "[examples/99-options](./examples/99-options)" to learn about it.
## Biz directory
Each file in the biz directory defines and handles an API. All files in the biz directory make up the API list.
```js
/root
/biz
/say
hi.js // api: /say/hi
about.js // api: /about
index.js
```
If there are some non-api files (only be used internally) in the biz directory, this will make the API list unclear. Then you should use the **api directory**, just create an empty file (or with the description of this api) to define an api. See "[examples/05-api-directory](./examples/05-api-directory)".
```js
/root
/api
/say
hi.js // api: /say/hi
about.js // api: /about
/biz
/__lib
/say
/__lib
hi.js
tools.js // non-api
check.js // non-api
about.js
init.js // non-api
index.js
```
## Performance
Noapi is a high-performance web API framework, faster than [Koa](https://github.com/koajs/koa), [Express](https://github.com/expressjs/express). See [API Framework Performance PK](https://github.com/hiowenluke/api-frameworks-performance-pk)
## Test
```sh
git clone https://github.com/hiowenluke/noapi
cd noapi
npm install
npm test
```
## License
[MIT](LICENSE)
Copyright (c) 2019, Owen Luke