search

Doodle3D / doodle3d-firmware

The API of the Doodle3D WiFi box. This can for example talk to print3d, save settings, update the firmware etc.
www.doodle3d.com
GNU General Public License v2.0
13 stars 9 forks source link

Rest API Documentation #20

Open peteruithoven opened 10 years ago

peteruithoven commented 10 years ago

We need more documentation about specifically the Rest API. The most simple way would be to complete the inline comments, explaining how it translate to API end points and use LDoc (which we already use) to automatically create the documentation webpages.

woutgg commented 10 years ago

ldoc is quite customizable, so inline documentation might indeed be a good approach.

peteruithoven commented 8 years ago

There are some tools to generate Rest api documentation. Usually this works by defining the api in a yaml like language and a html page can be generated from this.

Overviews / reviews

I would try Swagger first. I also prefer having a seperate api specification (seperate from the source code) because it's easier to include api's that's handled by other code (like the connect.doodle3d.com page) and because inline docs could really clutter the source code.