Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/j-siu/simple-api-express

simple-api-express is an expressjs api handler that work with simple-api-client-ng2 or simple-api-client-node
https://github.com/j-siu/simple-api-express

api api-handler api-server expressjs-api-handler node node-module nodejs

Last synced: 10 months ago
JSON representation

simple-api-express is an expressjs api handler that work with simple-api-client-ng2 or simple-api-client-node

Awesome Lists containing this project

README 

          
# Angular Simple API Express [![Paypal donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/donate/?business=HZF49NM9D35SJ&no_recurring=0&currency_code=CAD)



[simple-api-express](https://github.com/J-Siu/simple-api-express) is an ExpressJS api handler (NOT middleware) that work with [simple-api-client-ng2](https://github.com/J-Siu/ng2-simple-api-lib), an Angular api service.



### Table Of Content



- [Install](#install)

- [Usage Flow](#usage-flow)

- [API](#api)

  - [constructor](#constructor)

  - [debug](#debug)

  - [list](#list)

  - [register](#register)

  - [registerObject](#registerobject)

  - [response](#response)

  - [handler](#handler)

- [Error Handling](#error-handling)

  - [Not Found](#not-found)

  - [Callback throw](#callback-throw)

- [Example](#example)

- [Repository](#repository)

- [Contributors](#contributors)

- [Changelog](#changelog)

- [License](#license)



### Install



```sh

npm install simple-api-express

```



### Usage Flow



`simple-api-express` depends on ExpressJS middleware bodyParser for json body decode.



```javascript

const express = require('express');

var app = express();

var bodyParser = require('body-parser');

app.use(bodyParser.json());

app.listen(8080);

```



Import `simple-api-express`:



```js

const SimpleApi = require('simple-api-express').SimpleApi;

```



Create api object with base url:



```js

const apiDemoUrl = '/demo';

var apiDemo = new SimpleApi(apiDemoUrl, true); // enable debug

```



Register a function as api callback:



```js

apiDemo.register('echo2',param => 'echo2:' + param);

```



You can also register all functions of an object as api callbacks:



```js

apiDemo.registerObject(require('./api-object').DemoObj);

```



Use express post and `SimpleApi.response()` to handle incoming api request:



```js

// Post request + API response

app.post(path.join(apiDemoUrl, '*'), (req, res) => apiDemo.response(req, res))

```



`SimpleApi.handler()` can be use if additional action(eg: customizing response header or error page) is required before reply:



```js

// Post request + API handler

app.post(path.join(apiDemoUrl, '*'), (req, res) => {

  // Log request body before process

  console.log(req.body);

  try {

    // Manual handler used, server code responsible to send result and handle error

    // Use manual handler if custom header or custom 404 error are needed

    let result = apiDemo.handler(req);



    // Result must be return in json format

    res.json(result);

  }

  catch (e) {

    // Catch api not found error

    res.status(e.status).end(e.error);

  }

})

```



### API



#### constructor



`SimpleApi(baseUrl:string, debug:boolean)`



- `baseUrl` will prefix all api url registered to this SimpleApi instance.

- `debug` will enable/disable debug log. Default to false.



```js

const SimpleApi = require('simple-api-express').SimpleApi;

const apiDemoUrl = '/demo';

var apiDemo = new SimpleApi(apiDemoUrl, true); // enable debug

```



#### debug



`debug(enable: boolean)` can enable/disable debug log.



```js

apiDemo.debug(false);

```



#### list



`list()` return a `string[]` containing all registered api url.



```js

console.log(apiDemo.list());

```



Output:



```js

[ '/demo/echo', '/demo/echo2' ]

```



#### register



`register(url:string,callback)` register a callback function to `url`



- `url` : Api url path after baseUrl. The resulting url for the api is baseUrl/url.

- `callback` : a function that take a single argument as api parameter, and return a result.



```js

apiDemo.register('echo2',param => 'echo2:' + param);

```



#### registerObject



`registerObject(object)` register all functions of an object as api callbacks.



All functions of the object should take a single argument as api parameter, and return a result.



The function name will be used api url.



```js

var DemoObj = {

  echo(r) {

    return r;

  }

}



apiDemo.registerObject(DemoObj);

```



#### response



`SimpleApi.response(req, res)` is a handle function for incoming api post request. Api parameter will be passed to corresponding callback. Callback result will be passed back to api client.



`req, res` are request and response object pass in from ExpressJs post.



```js

// Post request + API response

app.post(path.join(apiDemoUrl, '*'), (req, res) => apiDemo.response(req, res))

```



#### handler



`SimpleApi.handler(req)` is an api handler function. It will invoke the corresponding callback base on the request url, and return the result.



IT WILL NOT send out the result.



IT IS NOT a ExpressJs post handler function. It needed to be called INSIDE the post handler function.



Api handler can be use if additional action(eg: customizing response header or error page) is required:



```js

// Post request + API handler

app.post(path.join(apiDemoUrl, '*'), (req, res) => {

  // Log request body before process

  console.log(req.body);

  try {

    // Manual handler used, server code responsible to send result and handle error

    // Use manual handler if custom header or custom 404 error are needed

    let result = apiDemo.handler(req);



    // Result must be return in json format

    res.json(result);

  }

  catch (e) {

    // Catch api not found error

    res.status(e.status).end(e.error);

  }

})

```



### Error Handling



There are two types of error.



#### 404 Not Found



When `response()` is called with an non-exist api url, it will response with a HTTP 404 Not Found.



When `handle()` is called with an non-exist api url, it will throw an error, which can be caught in the post handle function.



#### Callback throw



When `response()` is called, and the invoked api callback throw an error, which will be passed to remote client.



The remote client, using [simple-api-client-ng2](https://github.com/J-Siu/ng2-simple-api-lib), will throw an exception with the error.



When `handle()` is called, and the invoked api callback throw an error, the error can be inspected from the result object.



```js

let result = apiDemo.handler(req);



// If api callback return

if(result.error) {

  console.log(result.error);

}



// Result must be return in json format

res.json(result);

```



The remote client, using [simple-api-client-ng2](https://github.com/J-Siu/ng2-simple-api-lib), will throw an exception with the error.



### Example



A detail example for how [simple-api-express](https://github.com/J-Siu/simple-api-express) and [simple-api-client-ng2](https://github.com/J-Siu/ng2-simple-api-lib) work is in:



- [ng2-simple-api-lib](https://github.com/J-Siu/ng2-simple-api-lib)



### Repository



- [simple-api-express](https://github.com/J-Siu/simple-api-express)



### Contributors



- [John Sing Dao Siu](https://github.com/J-Siu)



### Changelog



- 1.2.0

  - Publish to NPM.

- 1.2.1

  - Fix Readme.md typo

- 1.2.2

  - Update package.json

  - Update Readme.md

- 4.0.0

  - Match ExpressJS major version

  - README.md clean up

  - package.json clean up

  - simple-api.ts uses typescript import

- 5.0.0

  - Move target from ES5 to ES2015



### License



The MIT License



Copyright (c) 2021



Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.