Skip to content

gettruly/truly-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

#Web Service API

Action HTTP method Relative URI

##Donors

Description Method Endpoint params res.body
Get a list of all donors GET /api/donors
Get a donor by ID GET /api/donors/:id email, name, phone
Create a new donor POST /api/donors email, name, phone id
Update a donor PUT /api/donor/:id
Delete a donor DELETE /api/donors/:id

##Shoes

Description Method Endpoint params res.body
Get a list of all shoes GET /api/shoes
Get a shoe by ref GET /api/shoes/ref organizationid, donorsid, img, size, type, gender, received_date, sent_date
Create a new shoe POST /api/shoes organizationid, donorsid, img, size, type, gender, received_date, sent_date ref
Update a shoe PUT /api/shoe/ref
Delete a shoe DELETE /api/shoes/ref

##Organizations

Description Method Endpoint
Get a list of all organizations GET /api/shoes
Get a organization by ID GET /api/organizations/id
Create a new organization POST /api/organizations
Update a organization PUT /api/organization/id
Delete a organization DELETE /api/organizations/id

##Test suit

Fire the server with node server.js and then do npm test.

##CURL EXAMPLES ⁄/ CREATE DONOR curl -X POST http://localhost:5000/api/donors -d '{"name":"JP", "email":"maria@gmail.com", "phone": "987654321"}' -H "content-type: application/json"

⁄/ CREATE SHOES curl -X POST http://localhost:5000/api/shoes -d '{"type":"sapatilha","gender":"m","size":45, "img":"HHHHHHH1X", "donorsid":"4"}' -H "content-type: application/json"

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •