https://github.com/meefik/run-as-api

Run heavy JavaScript calculations as a REST API
https://github.com/meefik/run-as-api

Last synced: about 1 month ago
JSON representation

Run heavy JavaScript calculations as a REST API

• Host: GitHub
• URL: https://github.com/meefik/run-as-api
• Owner: meefik
• License: isc
• Created: 2024-05-08T22:58:29.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-14T17:05:51.000Z (8 months ago)
• Last Synced: 2024-05-16T01:27:52.410Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 28.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# run-as-api

Run heavy JavaScript calculations as a REST API. You can write your own web services as JS functions that will run in a separate process on a first-come, first-served basis.

## How to use

1. Create the script file `echo.js` in the `/path/to/root` directory:

```js

export default async function (data, params) {

  console.log('echo task', params);

  return data;

}

```

The task will be queued for execution when an HTTP request is made to the server with the task name. The body of the request is parsed and passed to the function as the first input parameter. The data returned by the function is sent as a response to the client. The client's connection to the server remains open, waiting for a response until the function is completed.

2. Start the server to run tasks via REST API:

```sh

npx run-as-api --port=8000 --api-key=secret /path/to/root

```

3. Call your code with an HTTP request:

```sh

curl -X POST -H 'X-Api-Key: secret' http://127.0.0.1:8000/echo

```

An example of mapping an HTTP request path to a file in the `/path/to/root` directory:

```

/echo -> /path/to/root/echo.js 

/echo/ -> /path/to/root/echo/index.js

/sub/echo -> /path/to/root/sub/echo.js

```