Farmbot-Web-App icon indicating copy to clipboard operation
Farmbot-Web-App copied to clipboard

[Request] Auto-generated, publicly accessible API docs

Open phrohdoh opened this issue 7 years ago • 3 comments

Currently https://gist.github.com/RickCarlino/10db2df375d717e9efdd3c2d9d8932af exists but it would be very useful to have a, for example, https://api.farm.bot that detailed the available endpoints for data retrieval, creation, and issuing commands would be very useful for farmware and integration developers.

If something like this already exists please point me to it and close this ticket.

phrohdoh avatar May 09 '18 01:05 phrohdoh

#707 is related.

phrohdoh avatar May 09 '18 05:05 phrohdoh

Good point, @Phrohdoh.

A full blown developer documentation portal is on our agenda for the next month. It will have its own URL and be similarly structured to the way end-user software docs are, but with a focus on Farmware and 3rd party developers. I have a couple of things to finish up before then (pre-release bug fixes and variable declarations in the sequence editor), but it is coming up on my schedule very soon.

What other sorts of things do you (or anyone else reading this thread) want to see in these docs?

RickCarlino avatar May 09 '18 11:05 RickCarlino

It's been nearly a year, could we have swagger generated docs in the meantime?

Br3nda avatar Apr 15 '19 21:04 Br3nda