tindevour / backend Goto Github PK

All the data will be posted from the client should be encoded as JSON.

For endpoints described here, this is the data format:

1. POST /auth/login

{
  "username": "<username-here>",
  "password": "<password-here>"
}

2. POST /auth/logout

{}

3. POST /auth/register

{
  "name": "<name>",
  "username": "<username-here>",
  "password": "<password-here>",
  "email": "<email-here>",
  "skills": ["array", "of", "skill", "ids", "here"],
  "areas": ["array", "of", "area", "ids", "here"]
}

4. POST /users/:user/forgot-password

{}

5. POST /users/:user/password

{
  "password": "<new-password-here>"
}

6. POST /users/:user/spam

{}

7. POST /projects

{
  "title": "<project-title-here>",
  "description": "<project-description-here>",
  "skills": ["array", "of", "skill", "ids", "here"],
  "areas": ["array", "of", "area", "ids", "here"]
}

8. POST /projects/:project/spam

{
}

9. POST /projects/:project/liking

{
  "like": true // or false
}

10. POST /requests/:request

{
  "from": "<from-username-here>",
  "pid": "<pid-of-the-project-where-request-was-made>",
  "accept": true // or false
}

11. POST /chats/:chat/messages

{
  "message": "<the-sent-message-goes-here>"
}

You'd see that many of these are empty, that's because the data needed is already provided from the url or the session. Using this the client(our app) and server will communicate, and appropriate actions will be taken.

@tindevour

Currently there is inconsistency, some are using tabs, some spaces. This was introduced by using eclipse and vim together. Eclipse used tabs, and vim, spaces.

All of our data in the database has to be exposed via a REST API.

For example, if I were to create the /me endpoint, then here's how I'd go about implementing it:

1. Determine the current user from the session object. Use that username to get user information.
2. The response should contain all the information that our UI needs to display. The response would look something like this.

{
  "username": "meetmangukiya",
  "resume": "https://myrhy.me/resume",
  "additional_links": ["https://myrhy.me", "https://myrhy.me/blog", "https://github.com/meetmangukiya"],
  "skills": ["HTML5", "CSS3", "Python3", "Java8", "NodeJS"],
  "ideas": [...],
  "part_of_projects": [...] 
}

@tindevour

Currently the passwords are stored as-is which is a security flaw.