Code Monkey home page Code Monkey logo

surreal-api's Introduction

Surreal-API

A node.js REST API

  • nodejs (duh) + expressjs
  • passportjs for auth (LocalStrategy, BearerStrategy represented)
  • mongoosejs for talking to mongodb
  • SockJS for socket based power
  • mocha for unit testing

Version

0.1.0

##Requirements

##Getting Started

  • From within the root (surreal-api/) directory

     npm install
    
  • start the server

     nodemon server.coffee  
    
  • Create an account

     curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{ "email": "[email protected]", "name": "Your Name", "admin": true, "password": "yourpassword", "passwordConfirm": "yourpassword" }'  http://localhost:5008/api/user/register
    

    You'll get a response:

     "User Your Name ([email protected]) Created"
    
  • go ahead and give it a try--login:

     curl -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{ "email": "[email protected]", "password": "yourpassword" }'  http://localhost:5008/api/user/login
    

    If successful, you'll get a response:

     {
       "success": "Logged in.",
       "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.IjY5M2M0MDQ5Mjk1Zjk3ZWY5ZDkxNzc0YzczMmQxNmU2Ig.JMmUbTOs59sa2XffxoFBaqbSwHgWfjSZ-dZJeOa3q-s",
       "name": "Your Name"
     }
    

    You'll receive a response that contains the token you'll use for subsequent requests that require authentication. The access_token parameter must be included in every request, like so:

     curl -H "Accept: application/json" -H "Content-type: application/json" http://localhost:5008/api/user?access_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.IjY5M2M0MDQ5Mjk1Zjk3ZWY5ZDkxNzc0YzczMmQxNmU2Ig.JMmUbTOs59sa2XffxoFBaqbSwHgWfjSZ-dZJeOa3q-s
    

##TODO

  • build full User REST endpoints
  • Tighten up user auth with bcrypt

surreal-api's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.