Jump to content

Swagger For Api


Adam

Recommended Posts

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/

Link to comment
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Loading...
×
×
  • Create New...