An example of RESTful API backed by NodeJS/Express and Neo4j graph database.
Service allows to send friend requests between users, accept or decline them, list pending requests and browse friends or friends of friends.
See the API endpoints below.
Download and install NodeJS and Neo4j if you don't have them already:
Change API and database configuration in api/config.js.
Then run these commands:
- Install dependencies:
npm install - Populate database with the test data, located in test-data.cypher. Important, if you already have neo4j server locally you have to reset node ID counter in order tests to succeed. I usually do it by shutting down the service and removing neo4j data:
rm -rf data/graph.db - Run API server:
npm start - Optionally run tests:
npm test
By default API server will be started on this URL: http://localhost:8080/
Lists all user profiles.
Shows a specific user profile.
Lists all pending friend requests of a specific user.
Requests friendship to a specific user. ID of a user requesting friendship should be provided in the POST data, you should submit a JSON with a requester parameter. Example CURL request: curl -H "Content-Type: application/json" -X POST -d '{"requester":"123"}' http://localhost:8080/profiles/1/friend-requests. By default the "pending" status will be assigned to a newly created friend requests.
Used to accept or decline a friend request of a specific user using a :request_id parameter (retrieved from the above endpoint). You should submit a JSON with a status parameter with the value either accepted or declined. We will not be deleting a friend request, we might use this data later for analysis...
Lists all friends of a specific user.
Lists all "friends of friends" of a specific user. Goes on a depth of 3rd level.