search

BillikenValley / APIServer

Go API Server
0 stars 0 forks source link

Define a Minimal REST API #2

Open Dacode45 opened 8 years ago

Dacode45 commented 8 years ago

In the Readme, define a REST API for how the webserver affects the model.

Format should be like the following.

/* Users: users contain the information for the people associated with this app */
GET /api/v1/users?{first_name="David"} // Get's a list of all users in this app
GET /api/v1/users/:username // Get's a user by username
...
*/

Some rules,

  1. Prefer underscore
  2. Make sure every top level model has GET, POST, PUT, and DELETE
  3. PUT and POST are different. Post should only ever upload records. PUT should update them.
Dacode45 commented 8 years ago

Currently wating on review http://docs.homeme.apiary.io/