Swagger For Api

[Adam]

Howdy,

 

A suggestion I have for the API that blesta offers is to replace (or add to) the Confluence page you have on API[1] and use Swagger[2] to automatically generate the docs for you.

 

The benefit is that its developer friendly for Blesta AND consumers of the API. You also get some added benefits like a free command line tool to interact with the API. All Swagger does is generate 'swagger doc' (think IDL/WADL) that drives the online web pages or command line interface, or xyz. This[3] is the classic pet store example.

 

thanks,

/adam

 

 

[1]: http://docs.blesta.com/display/dev/API

[2]: http://swagger.io/

[3]: http://petstore.swagger.io/

[Tyson]

The API docs are generated by APIGen. However, the page you referenced is not the API docs, but rather documentation about configuring/expanding the API. The API source docs are available here.

 

Swagger has some interesting features, though.