Skip to content

Feat api doc

Cyril Vazquez requested to merge FEAT_API_doc into develop

Openapi documentation

Added A new front-end script web/openapi.php that produces the openapi/swagger V2.0 documentation

Basic use :

http://host/openapi.php will produce the documentation for the entire application, including all paths and definitions.

Params :

  • method : Restricts documentation on the given method name
  • path : Restricts documentation on the given path, i.e. bundle/api

Example : http://host/openapi.php?method=post&path=recordsManagement/archive will produce the documentation for the request URI POST /recordsManagement/archive

Merge request reports