7.7 KiB
API
Baby Buddy uses the Django REST Framework (DRF) to provide a REST API.
The only requirement for (most) requests is that the Authorization
header is
set as described in the Authentication section. The one
exception is the /api
endpoint, which lists all available endpoints.
Currently, the following endpoints are available for GET
, OPTIONS
, and
POST
requests:
/api/children/
/api/changes/
(Diaper Changes)/api/feedings/
/api/notes/
/api/sleep/
/api/temperature/
/api/timers/
/api/tummy-times/
/api/weight/
Authentication
By default, the TokenAuthentication and SessionAuthentication classes are enabled. Session authentication covers local API requests made by the application itself. Token authentication allows external requests to be made.
❗ In a production environment, token authentication should only
be used for API calls to an https
endpoint. ❗
Each user is automatically assigned an API key that can be used for token
authentication. This key can be found on the User Settings page for the logged
in the user. To use a key for an API request, set the request Authorization
header to Token <user-key>
. E.g.
Authorization: Token 2h23807gd72h7hop382p98hd823dw3g665g56
If the Authorization
header is not set or the key is not valid, the API will
return 403 Forbidden
with additional details in the response body.
Schema
API schema information in the OpenAPI format
can be found in the openapi-schema.yml
file in the project
root. A live version is also available at the /api/schema
path of a running
instance.
GET
Method
Request
The limit
and offset
request parameters can be used to limit
and offset the results set respectively. For example, the following request
will return five diaper changes starting from the 10th diaper change entry:
curl -X GET 'https://[...]/api/changes/?limit=5&offset=10' -H 'Authorization: Token [...]'
{
"count": <int>,
"next": "https://[...]/api/changes/?limit=5&offset=15",
"previous": "https://[...]/api/changes/?limit=5&offset=5",
"results": [...]
}
Field-based filters for specific endpoints can be found the in the filters
field of the OPTIONS
response for specific endpoints.
Single entries can also be retrieved by adding the ID (or in the case of a Child entry, the slug) of a particular entry:
curl -X GET https://[...]/api/children/gregory-hill/ -H 'Authorization: Token [...]'
{
"id":3,
"first_name":"Gregory",
"last_name":"Hill",
"birth_date":"2020-02-11",
"slug":"gregory-hill",
"picture":null
}
curl -X GET https://[...]/api/sleep/1/ -H 'Authorization: Token [...]'
{
"id":480,
"child":3,
"start":"2020-03-12T21:25:28.916016-07:00",
"end":"2020-03-13T01:34:28.916016-07:00",
"duration":"04:09:00",
"nap":false
}
Response
Returns JSON data in the response body in the following format:
{
"count":<int>,
"next":<url>,
"previous":<url>,
"results":[{...}]
}
count
: Total number of records (in the database, not just the response).next
: URL for the next set of results.previous
: URL for the previous set of results.results
: An array of the results of the request.
For single entries, returns JSON data in the response body keyed by model field names. This will vary between models.
OPTIONS
Method
Request
All endpoints will respond to an OPTIONS
request with detailed information
about the endpoint's purpose, parameters, filters, etc.
Response
Returns JSON data in the response body describing the endpoint, available
options for POST
requests, and available filters for GET
requests. The
following example describes the /api/children
endpoint:
{
"name": "Child List",
"renders": [
"application/json",
"text/html"
],
"parses": [
"application/json",
"application/x-www-form-urlencoded",
"multipart/form-data"
],
"actions": {
"POST": {
"id": {
"type": "integer",
"required": false,
"read_only": true,
"label": "ID"
},
[...]
}
},
"filters": [
"first_name",
"last_name",
"slug"
]
}
POST
Method
Request
To add new entries for a particular endpoint, send a POST
request with the
entry data in JSON format in the request body. The Content-Type
header for
POST
request must be set to application/json
.
Regular sanity checks will be performed on relevant data. See the OPTIONS
response for a particular endpoint for details on required fields and data
formats.
Timer Field
The "timer" field is a special field available for POST
operations to model
endpoints supporting duration (Feeding, Sleep, Tummy Time). When the "timer"
field is set in the request, the start
and end
fields will be filled in
automatically using the start
and end
values from the Timer (the Timer
will be stopped if it is currently running).
Additionally, if the Timer has a Child relationship, the child
field will be
filled in automatically use the child
value from the Timer.
If the "timer" field is set, it's values will always override the relevant
fields in the request. E.g. if a POST
request is sent with both the timer
and end
fields, the value for the end
field will be ignored and replaced by
the Timer's end
value. The same applies for start
and child
. These fields
can all be left out of the request when the Timer is provided, otherwise they
are required fields.
Response
Returns JSON data in the response body describing the added/updated instance or
error details if errors exist. Errors are keyed by either the field in error or
the general string non_field_errors
(usually when validation involves
multiple fields).
PATCH
Method
Request
To update existing entries, send a PATCH
request to the single entry endpoint
for the entry to be updated. The Content-Type
header for PATCH
request must
be set to application/json
. For example, to update a Diaper Change entry with
ID 947 to indicate a "wet" diaper only:
curl -X PATCH \
-H 'Authorization: Token [...]' \
-H "Content-Type: application/json" \
-d '{"wet":1, "solid":0}' \
https://[...]/api/changes/947/
Regular sanity checks will be performed on relevant data. See the OPTIONS
response for a particular endpoint for details on required fields and data
formats.
Response
Returns JSON data in the response body describing the added/updated instance or
error details if errors exist. Errors are keyed by either the field in error or
the general string non_field_errors
(usually when validation involves
multiple fields).
DELETE
Method
Request
To delete an existing entry, send a DELETE
request to the single entry
endpoint to be deleted. For example, to delete a Diaper Change entry with ID
947:
curl -X DELETE https://[...]/api/changes/947/ -H 'Authorization: Token [...]'
Response
Returns an empty response with HTTP status code 204
on success, or a JSON
encoded error detail if an error occurred (e.g. {"detail":"Not found."}
if
the requested ID does not exist).