GitLab

This is a simple framework to implement services in ERP5 based on an OpenAPI document.

A new type "Open API Type" (similar to "Base Type") is introduced, this is responsible for the definition of operations and types. The Open API document is set as text content of the Open API Type and can be edited from the Open API Type.

For each service, a new portal type will be created. The portal type use OpenAPIService as class and this is responsible for serving requests. The process of serving requests is:

• find the matching operation from the request method and request path
• extracting request parameters and request body using the parameter definitions from the Open API Document
• validate parameters and request body according to the schema from the Open API document
• finding the method, this is done by using _getTypeBasedMethod with the operationId
• calling the method and formatting the result or handling error. The default handling of errors is to reply with rfc7807 json responses, but it can be customized by defining an handleException type based method.

Typically, the services will be created in portal_web_services. From there, there is also a view using a new SwaggerUI gadget to try out the API.

What's not supported:

• OpenAPI document in YAML format is only partially supported and have some limitations over JSON:
  • On python2 the order of operations is lost, the lookup of operations is not made in the order of the operations from the document. Also the operations are not in order in the SwaggerUI gadget.
  • The text editor does not provide rich editing of YAML
• "partial" parameters in path elements ( /users/{user_id} is supported, but /documents/report.{format} is not )
• XML (decoding of request bodies and parsing of responses) is not supported.