Use the rspec_api_documentation API to extract info about docs

[SrMouraSilva]

Hello, it's possible use the API of the rspec_api_documentation to extract information about the elements returned?

I'm thinking in develop a object diagram generator using plant uml to auto docs generation. I know that the information about the generated output works, but use the rspec_api_documentation API maybe is more functional.

In this line of thinking, it would be interesting to be able to define custom parameters for the methods, routes and parameters. Maybe as a META information.

[SrMouraSilva]

Update status. I implemented an automatic generation of the diagram using the .yml generated by rspec_api_documentation.

However the need for Issue still persists. The data is still useful for performing an automatic scan if the return data is as specified and if all of the return data is documented (or if something else is documented).

I did an initial implementation, but I have to get some internal data by "reverse engineering", something quite susceptible to error in an update.

Another use I make is to mask the data displayed in the documentation using Faker Gem together.

If any APIs are prepared, I can send a merge request with these new options to the library. I believe it would be a good contribution to the community.