Specs update suggestions

[nhaancs]

Frontend

• Could we remove # character from url? I think the url will look better without #.

Backend

• Use abstract keywork in responses to make them more abstract and reusable.
  • For example, with get single article api we can return:

  {
    "data": {
       ...
     }
   }
  

  instead of

  {
    "article": {
       ...
     }
   }
  

  • With get list of articles api we can return:

  {
    "data": [
       ...
     ],
     "total": 20
   }
  

  instead of

  {
    "articles": {
       ...
     },
     articlesCount: 20
   }
  

  • And the same for update, create responses
• Server also return messages for create, update, delete, favorite,.. requests. For example: {..., message: "article created successfully"}
• A create api should only return created id, frontend need to call api with the id to get what it needs

[geromegrignon]

Hello @nhaancs,

Could we remove # character from url? I think the url will look better without #.

Indeed. It's being tracked already with #536

About the API specs, we'll adress them with the ongoing v2 as it would introduce breaking changes on implementations fro the current version.

[geromegrignon]

Server also return messages for create, update, delete, favorite,.. requests. For example: {..., message: "article created successfully"}

What's the motivation? The 2xx is enough information for clients to be confident that their request was properly handled.

[geromegrignon]

A create api should only return created id, frontend need to call api with the id to get what it needs

About such change, I would propose not to include data for PUT requests