iq-scm / personal-api Goto Github PK

personal-api

API server to publish personal info. Example APIs: alperkan.at, api.azer.io

$ personal-api azer.json

Install

$ npm install -g personal-api

Usage

Create a JSON file of your personal info:

{
  "name": "Azer Koçulu",
  "email": "[email protected]",
  "age": "26",
  "gender": "male",
  "city": "Oakland",
  "hometown": "Kalkan",
  "instagram": "oakazer",
  "photo": "http://farm4.staticflickr.com/3674/8760363780_cdbe567873_o.jpg",
  "favorite food": "mantı",
  "favorite show": "leyla ile mecnun",
  "religious view": "atheist"
}

And start the server:

$ personal-api me.json

Run personal-api -h or see docs/man for command-line options.

Running Programmatically

var api = require('personal-api')

api.start('me.json', 8000, 'localhost')

You can customize the output depending on the Accept type:

api.server.format('/', 'text/plain', function (context, match) {
  return {
    contentType: 'text/plain',
    response: 'Name: ' + context.result.name + ' E-Mail: ' + context.result.email
  };
});

Compatible with cats

It'll work for cats, as well. Example cat API: blackbear.api.azer.io