Changes

Jump to navigation Jump to search
1,379 bytes added ,  15:01, 26 November 2022
Line 1: Line 1:  
== Introduction ==
 
== Introduction ==
 +
This page reflects my experience in using the various API suites (product, search, image, robotoff, folksonomy) available on OFF. These implementations can sometimes be streamlined and synchronised.
 +
 +
My experience is based on implementing the API's in Swift 4.0 on Xcode. I want to be able to implement the API's only with the Swift libraries and minimal coding. If I need to cater for an exception in the API or the Json -results, then there is something wrong in the API design.
 +
 
== API Call ==
 
== API Call ==
 
Is it possible to streamline the various API calls?
 
Is it possible to streamline the various API calls?
   −
== API version number ==
+
=== API version number ===
 
Add the API version number to each call as a path (Robotoff)
 
Add the API version number to each call as a path (Robotoff)
 +
=== Path parameters vs Queries ===
    
== Output ==
 
== Output ==
 +
All API calls should result in a json response.
 +
 +
=== Single json response ===
 +
=== Response wrapper ===
 +
The wrapper contains the meta data of the response, i.e. whether the request was successful, how many results are available, etc. The usual possible parameters:
 +
* status (string) - the quality of a successful response: '''found''' or '''not found'''.
 +
* count (uint) - the number of results
 +
Missing from this wrapper are the original query, which would make the json-response independent of the query. It would be nice to have as well:
 +
* number of items in response (uint) - how many items are contained in the response?
 +
* page number (uint) - which page do these items belong to (is page 0 the first 25 items?)
 +
* time stamp (time) - so when we look at the json later we can tell how old the data is.
 +
 +
=== Free dictionaries ===
 +
=== Dependent field names ===
 
[[Category:API]]
 
[[Category:API]]
3,393

edits

Navigation menu