Skip FOLIO Project Navigation

As explained in the Primer for back-end development there are various supporting libraries which can be utilised to ease development with OpenAPI.

FOLIO currently uses OpenAPI (OAS) version 3.0

Use “api-lint” to assess API descriptions, schema, and examples. A script is provided, to find files and run it. That script can be run locally, and is also utilised by the continuous-integration.

Describe schema and properties.

Use “api-doc” to generate documentation from the API descriptions, schema, and examples. That script can be run locally, and is also utilised by the continuous-integration to build the FOLIO API documentation.

Investigate the other OpenAPI-using server-side modules.

Reference API documentation is automatically generated by the continuous integration, for modules that are managed with the FOLIO CI.