Project

General

Profile

action #95084

Updated by tinita about 1 year ago

We have several places where information on our API is stored. 

 * WebAPI.pm includes the route definitions for Mojolicious. 
 * In the actual methods, we have the `validation` object to define parameter validation. 
 * In our documentation we have *some* API examples 

 Changing or adding things to the API often results in forgetting docs and/or validation. 

 Having the definitions all in one place avoids that, and can serve as documentation as well, or at least we can generate documentation from it. 

 Having the definitions in a data format allows to easily port to other data formats in the future, e.g. openAPI (also known as Swagger). future.

Back