node-neo4j-swagger-api

This is an open source node neo4j api server based on node-neo4j-template and swagger-node-express

The idea is to make it as easy as possible to create an API using Node.js and Neo4j that can be consumed by some other app. Swagger provides interactive documentation so that it is easy to interact with the API. The goal is merge Swagger with Neo4j queries and visualizations so developers can see how Neo4j and the API results relate to each other.

Try it out at neo4j-swagger

Resources

• Neo4j-Swagger UI - neo4j-swagger client
• Neo4j-Architect - neo4j query builder
• Node-Neo4j - neo4j client library
• Neo4j - Main Neo4j site.
• Graphene DB - Neo4j Cloud Host
• node-neo4j-template - How I got started with neo4j and node
• Swagger-Node-Express - Merges swagger and express
• Swagger - Learn more about Swagger
• graphgist - gists made for neo4j with awesome visualizations

Built focusing on using Cypher and Neo4j 2.0

Neo4j-Swagger Diagram

Prerequisites

• Neo4j
• Node.js

Getting Started

• clone git clone https://github.com/tinj/node-neo4j-swagger-api.git
• npm install
• have a neo4j server up at localhost:7474 or NEO4J_URL specified in .env
• node app.js
• visit http://localhost:3000/docs

TODO

I'm using Trello for my todo list, feel free to comment!

1. Move neo4j queries and results to swagger client
2. Add graph visualization to swagger client
3. improve swagger model format
4. add second node type (pets?)
5. add queries relating users and pets
6. TESTS!!!
7. ...

More details about goals

So basically, Swagger creates interactive API docs, which is great but I also want to see what's going on with Neo4j at the same time

The idea is to pass raw query/results optionally in API responses which could be visualized on the Swagger client along side the API results

end result being i can see what Neo4j and my API are doing side by side in the web client so I can stop debugging in the console

MIT License