How to document a Rest C ++ API automatically?

Asked Nov 08 '19 at 19:08

Active Nov 08 '19 at 22:58

Viewed 295 times

I have a Rest API in C ++, ready and working correctly. It is not simple, with many files (.hpp, .cpp, .h etc.) plus many libraries and dependencies However, I would like to know if there is any way to do the automatic documentation of this API, so that the new features added will also be documented automatically.

As a result of my research, the solution would be to use the Oat++ (oatpp) template, as in this example (available on this Medium post), but for that I should modify the existing code, which I don't want to do (since I am not the author). Has anyone been through something similar and could help me?

edited Nov 08 '19 at 22:58

Canica

2,650
3
18
34

asked Nov 08 '19 at 19:08

Paulinelly Oliveira

You can try https://swagger.io/ – Thomas Sablik Nov 08 '19 at 19:11
Nothing is documented "automatically" - *someone* has to actually *write* meaningful documentation text *somewhere*. – Jesper Juhl Nov 08 '19 at 19:12
Even if not automatically, is there any way to document without modifying the current code? – Paulinelly Oliveira Nov 08 '19 at 19:22
@PaulinellyOliveira I find that well separated and well explained markdown files are nice. – Guillaume Racicot Nov 08 '19 at 20:03
You can get skeleton swagger docs from the endpoint configuration if your chosen web framework supports it. What web server is your existing code currently using? (but I agree with @GuillaumeRacicot 's point. After a certain level of complexity, quality hand-written documentation is a must) – parktomatomi Nov 08 '19 at 20:06

How to document a Rest C ++ API automatically?

0 Answers0