Making data readily available to anyone interested
JavaScript Makefile
Latest commit 3f8ccca Oct 14, 2016 @kristjanmik kristjanmik committed on GitHub Added try around module loader

README.md

Codeship Status for apis-is/apis

APIs.is - Making data pretty since 2012!

The purpose of APIs.is is to make data readily available to anyone interested. All data that is delivered through APIs.is is JSON formatted and scraped from open public websites.

The code that is running the service is open source under the MIT licence. The platform itself is hosted on a load balanced setup by Advania.

Don't hesitate to lend a hand - All knowledge and help is much appreciated!

Maintainers

@kristjanmik

@benediktvaldez

@koddsson

@MiniGod

Running locally

To run the project locally, first clone this repository...

$ git clone https://github.com/apis-is/apis.git

... install the dependencies and run the project.

$ npm install
[Bunch of output]
$ npm run

Tests

To run the tests:

$ npm test

Adding a new Endpoint

Step by Step

  1. View current endpoints for structure and hierarchy.
  2. Add a new folder to the endpoints/ directory with the name of your endpoint.
  3. The file will be loaded automatically. Remember to require the server. Bare minimum example endpoint:
import app from '../../server';

app.get('/path', (req,res) => {
  //Sends out empty json object
  return res.json({});
});

Additional requirements

Add integration tests to the endpoint by creating a file called integration_test.js inside a tests/ folder within your endpoint directory. For reference, please take a look at one of the integration tests.

Add documentation for your endpoint to the gh-pages branch of this repo.

More servers

To ensure close to zero downtime, the plan is to start up more workers/servers around the world so that projects relying on this service will not be affected. Want to help out with that? Feel free to contact us by opening a issue.

Helpful pointers

  • Endpoints can implement any node module, but try to use the ones that are already included in the project.
  • Information on how to handle requests and responses can be found here.
  • It is much appreciated that endpoints are thoroughly documented and written with care.
  • Issues are managed by the GitHub issue tracker.
  • Have fun and eat some cake! (preferrably just some plain vanilla cake, but whatever floats your boat)