Skip FOLIO Project Navigation

This is not a easy topic in the new FOLIO multi-module system. Techniques for gathering and navigating the relevant information are under development.

Jump to the current best facility, the UI Developer Settings.

API documentation

There is the set of API documentation which is automatically generated from each separate back-end module’s RAML files and JSON Schemas. Developers could wade through that, making an educated guess. (There are tickets in the Issue tracker to improve that aspect of the API documentation, but not happening yet.)


Or developers could confirm that a certain back-end module provides a certain interface which handles a set of endpoints. Again an educated guess. Obtain its ModuleDescriptor from the registry and extract the “provides” section. For example:

curl -s -S -w'\n' \
  '' \
  | jq '.[].provides'

UI Developer Settings

The best facility at this stage of the project is provided by the ui-developer module.

Do login to the relevant running FOLIO system, and visit the “Settings : Developer : Okapi paths” page. This will list the “resource path to interface mapper” for all of the modules configured for that FOLIO instance.
For example:

Also the “resource path to permission-set mapper” shows which permissions are needed in order to access a certain endpoint:

Developers will also find other gems at the Developer Settings area.