Actions
action #95084
openCreate a data file with openQA API routes, parameters, docs
Start date:
2021-07-05
Due date:
% Done:
0%
Estimated time:
Description
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
validationobject 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).
Actions