Difference between revisions of "API Design experience"

From Open Food Facts wiki
Jump to navigation Jump to search
Line 3: Line 3:
 
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)
  
 
== Output ==
 
== Output ==
 +
=== 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.
 
[[Category:API]]
 
[[Category:API]]

Revision as of 08:26, 26 November 2022

Introduction

API Call

Is it possible to streamline the various API calls?

API version number

Add the API version number to each call as a path (Robotoff)

Output

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.