raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-03-04 02:31:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated API documentation (markdown)

Luis Ramos
2019-08-18 18:05:17 +01:00
parent ecf6ac7f46
commit 6cc7a5189d
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
API-documentation.md

@@ -1,11 +1,15 @@
This page describes Open Food Network's API. It is based on Spree's API,
which has [extensive documentation](https://guides.spreecommerce.com/api/)
([source](https://github.com/spree/api.spreecommerce.com)). See also
[spree-api's routes.rb](https://github.com/spree/spree/blob/master/api/config/routes.rb).
This page is UNDER CONSTRUCTION until https://github.com/openfoodfoundation/openfoodnetwork/issues/3001 is considered completed/closed.
The Open Food Network API is not finished. Entries that are ~~crossed out~~
are candidates for addition.
This page describes Open Food Network's API.
OFN API is no longer based on Spree's API and only includes OFN specific endpoints.
##### Some basic API implementation details for developers
The OFN API is implemented in a specific namespace /api. There are quite a few endpoints that are not under /api that render json, particularly in /admin (Where they are mixed with html rendering endpoints). We do not consider these endpoints as part of the OFN API.
AMS is the serialization solution used in the OFN API, that means we stopped using rabl files in OFN.
In OFN codebase, there should be no API code under app/views because AMS serializers should all be under /app/serializers.
## Quick links