Git Product home page Git Product logo

hnews's Introduction

hnews

This repository define APIs for a sample web site like hackernews. My main idea was about learning Ruby on Rails for back-end and React for front-end so I design an API to implement for both back-end and fornt-end.

Implementations

List of APIs

Name URI Verb
Registration api/users POST
Login api/users/login POST
Get Current User api/user GET

APIs Descriptions

Registration (Sign Up new user)

POST api/users

Body

{
  "user":
  {
    "email":"[email protected]", 
    "password":"pasword", 
    "username":"example"
  }
}

Result

{
  "user": {
      "id": 5,
      "email": "[email protected]",
      "username": "example",
      "bio": null,
      "token": "eyJhbGciOiJIUzI1NiJ9.eyJpZCI6NSwiZXhwIjoxNTM3OTQ0ODM2fQ.OAenR46hZ4Yk0a2fpvlqMd9819BZGjKuWVQcv01iTew"
  }
}

Login

POST api/users/login

body

{
  "user": {
    "email":"[email protected]",
    "password":"pasword"
    }
}

Result

{
  "user": {
      "id": 5,
      "email": "[email protected]",
      "username": "example",
      "bio": null,
      "token": "eyJhbGciOiJIUzI1NiJ9.eyJpZCI6NCwiZXhwIjoxNTM3ODk2NTE0fQ.FqTup-cjeec-Jd8g9u8oLTICG8ksq-nzBoS8SPNDcDo"
  }
}

Current User

GET /api/user

header

  Authorization: Token {{token}}

Result

{
  "user": {
      "id": 5,
      "email": "[email protected]",
      "username": "example",
      "bio": null,
      "token": "eyJhbGciOiJIUzI1NiJ9.eyJpZCI6NCwiZXhwIjoxNTM3OTQ1Mjk0fQ.zm88z-EjicCxoD8vcEAwGmb6kQWd0gBgztLtdxZfd3A"
  }
}

hnews's People

Contributors

mshirdel avatar

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.