search

joffrey-bion / livedoc

A not-so-annotation-based documentation generator for REST and websocket services
MIT License
4 stars 2 forks source link

Make sure the Livedoc model is properly documented so that /jsondoc is itself documented #22

Open joffrey-bion opened 7 years ago

joffrey-bion commented 7 years ago

The structure of the JSON sent on the documentation endpoint could also be documented using Livedoc itself. This would allow to build other UIs on top of the JSON output.

joffrey-bion commented 6 years ago

Would that be really relevant? If someone is able to read the Livedoc of Livedoc, then that someone could read the Livedoc of anything without using the Livedoc of Livedoc.

That being said, it would be funny.

joffrey-bion commented 6 years ago

It actually would make sense when the code-generation feature is available. Also, now that Livedoc supports Javadoc, there is no real need to add any Livedoc annotation anywhere in the model. On the other hand, proper Javadoc doesn't hurt, even for a model that seems "internal", so it's a win-win.

ST-DDT commented 6 years ago

Then maybe you could add them to the sample app to showcase them as well.

joffrey-bion commented 6 years ago

That's actually already planned, this is why I brought back this issue :) I just need to add the org.hildan.livedoc package to the list and these classes will be documented. However, I'm not sure there is a point in showcasing them yet, as this will probably overwhelm the users with unnecessary information, drowning the actual example data about authors and books.