Home

Awesome

apibone

npm version npm download dependencies license

apibone is an unified platform for queryable services. It simply provides environment-agnostic interfaces/objects for its modules.

apibone modules query various web services and return responses in requested formatting. Whether the platform is cli or web, modules access same interface for input and output objects.

Queries

Apibone breaks queries in three parts:

in command line form:

module [arguments ...] [--parameter value ...]

For example, to execute rates module in order to query 5 USD's TRY value:

$ apibone module rates usd try --amount 5 # cli example
http://example.com/rates/usd/try?amount=5 # web example

module: module name which will be called. (e.g.: rates)
arguments: arguments of operation (e.g.: first argument is usd, second argument is try)
parameters: optional settings for operation (e.g.: amount with value 5)

Installation

$ npm install -g apibone
$ mv config.sample.js config.js # rename config.sample.js to config.js

CLI Usage

$ apibone module [arguments]

# Examples:
$ apibone modules
$ apibone salyangoz --limit 2
$ apibone salyangoz --limit 2 --format json
$ apibone rates usd try
$ apibone rates usd try --amount 5
$ apibone weather izmir
$ apibone test anyCommand --anyParam=anyValue --anyOptionalParam

REPL Usage

$ apibone

apibone> modules
apibone> weather izmir
apibone> /q

Web Usage

$ npm start

# Example:
http://localhost:3000/modules
http://localhost:3000/salyangoz?limit=2
http://localhost:3000/rates/usd/try?amount=5
http://localhost:3000/weather/izmir
http://localhost:3000/test/anyCommand?anyParam=anyValue&anyOptionalParam&format=text

Start as a Telegram Bot

$ node ./lib/telegrambot.js

Modules

Requirements

License

MIT, for further details, please see LICENSE file.

Contributing

See contributors.md

It is publicly open for any contribution. Bugfixes, new features and extra modules are welcome.