1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
Backend API
===========
Tucker Evans
v1.1, December 9, 2019
This REST API allows you to access recipe information in our database with
simple HTTP requests. There is currently no authentication/authorization of
clients. It return recipes in JSON format together with some status information
about the request.
JSON format
-----------
The current implementation expects (and returns) recipes in the form:
.Recipe JSON
[source,json]
----
{
"id": 0,
"name": "Recipe name",
"description": "Recipe Description",
"photos": [
"photo_url_1",
"photo_url_2"
],
"servingSize": 0,
"cookTime": 0,
"rating": 0,
"timesCooked": 0,
"tags": [
"keyword 1",
"keyword 2",
"keyword 3"
],
"ingredients": [
{
"name": "Ingredient 1 Name",
"amount": 1.0,
"unit": "Ingredient Units"
"type_": ""
},
],
"steps": [
{
"instructions": "Step Instructions/Description",
"timer": 0
}
]
}
----
[NOTE]
`"id"` is not required for a POST request, and will be ignored.
[IMPORTANT]
Keywords and Photo URLs are currently stored as pipe separated values, the
parsing of which is not complete and as such there is a extra empty string
(`""`) is appended to these lists in the response (it is not required in
requests)
.Response JSON
[source,json]
----
{
"Status": {
"Code": 200,
"Msg": "Successful"
},
"Data": "<DATA>"
}
----
[NOTE]
Data will either be a Recipe object or a list of recipe ids (null is also a
valid value).
Status Codes
~~~~~~~~~~~~
Status codes are based on https://httpstatuses.com/[HTTP status codes].
.Currently Used
- 200 OK
- 201 Created
- 400 Bad Request
- 404 Not Found
- 405 Method Not Allowed
- 409 Conflict
- 422 Unprocessable Entity
- _500 Internal Server Error_ (not yet implemented)
The messages included in the status section are meant to be human readable
descriptions of any error.
Usage
-----
This api is currently availiable with a base URL of
http://api.recipebuddy.xyz:8888.
CRUD Interface
~~~~~~~~~~~~~~
NOTE: Examples are run with a database that contains 1 recipe (you can see the
initial contents of this recipe in the read example).
Create
^^^^^^
Creating a recipe is done by sending a `POST` HTTP request to the location
http://api.recipebuddy.xyz:8888/recipes[`/recipes`], with a body containing a
recipe object in JSON form:
[source,bash]
----
$ curl -X POST api.recipebuddy.xyz:8888/recipes -d '
{
"name":"Test Recipe 2",
"description":"This is a descripiton for the test recipe",
"photos":["photo_url_1","photo_url_2"],
"servingSize":0,
"cookTime":60,
"rating":5,
"tags":["keyword_1", "keyword_2","keyword_3"],
"ingredients":[
{"name":"INGR 1","amount":2.5,"unit":"cups"},
{"name":"INGR 2","amount":1,"unit":"oz"}
],
"steps":[
{"instructions":"Step 1: Do this first","timer":10}
]
}'
{"Status":{"Code":201,"Msg":"Recipe added successfully"},"Data":{"id":2,"name":"Test Recipe 2","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2"],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3"],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instructions":"Step 1: Do this first","timer":10}]}}
----
Read
^^^^
Reading a recipe is done by sending a `GET` HTTP request to the location
http://api.recipebuddy.xyz:8888/recipes/0[`/recipes/{id}`], the HTTP body is ignored.
[source,bash]
----
$ curl -X GET api.recipebuddy.xyz:8888/recipes/1
{"Status":{"Code":200,"Msg":"Successful"},"Data":{"id":1,"name":"Test Recipe","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2",""],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3",""],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instructions":"Step 1: Do this first","timer":10}]}}
----
To access a list of all recipe ids in the database send a `GET` request to
http://api.recipebuddy.xyz:8888/recipes[`/recipes`], the HTTP body is ignored.
[source,bash]
----
curl -X GET api.recipebuddy.xyz:8888/recipes
{"Status":{"Code":200,"Msg":"Successful Request"},"Data":[1,2]}
----
Update
^^^^^^
Updating a recipe is done by sending a `PUT` HTTP request to
http://api.recipebuddy.xyz:8888/recipes/0[`recipes/{id}`], the HTTP body should be a
complete recipe in JSON form.
[source,bash]
----
$ curl -X PUT localhost:8888/recipes/1 -d '
{
"id": 1,
"name":"Test Recipe 1",
"description":"This is a descripiton for the test recipe",
"photos":[ "photo_url_1", "photo_url_2" ],
"servingSize":0,
"cookTime":60,
"rating":5,
"tags":[ "keyword_1", "keyword_2", "keyword_3" ],
"ingredients":[
{ "name":"INGR 1", "amount":2.5, "unit":"cups" },
{ "name":"INGR 2", "amount":1, "unit":"oz" }
],
"steps":[
{ "instructions":"Step 1: Do this first", "timer":10 }
]
}'
{"Status":{"Code":201,"Msg":"Recipe added successfully"},"Data":{"id":1,"name":"Test Recipe 1","description":"This is a descripiton for the test recipe","photos":["photo_url_1","photo_url_2"],"servingSize":0,"cookTime":60,"rating":5,"timesCooked":0,"tags":["keyword_1","keyword_2","keyword_3"],"ingredients":[{"name":"INGR 1","amount":2.5,"unit":"cups"},{"name":"INGR 2","amount":1,"unit":"oz"}],"steps":[{"instructions":"Step 1: Do this first","timer":10}]}}
----
[WARNING]
Any recipe information not included in the request will be removed from the
database.
Delete
^^^^^^
Deleting a recipe is done by sending a `DELETE` HTTP request to
http://api.recipebuddy.xyz:8888/recipes/0[`recipes/{id}`], the HTTP body is ignored.
[source,bash]
----
$ curl -X DELETE api.recipebuddy.xyz:8888/recipes/2
{"Status":{"Code":200,"Msg":"Recipe Deleted Successfully"},"Data":null}
$ curl -X GET api.recipebuddy.xyz:8888/recipes
{"Status":{"Code":200,"Msg":"Successful Request"},"Data":[1]}
----
[WARNING]
This is currently a *HARD* delete.
|
