You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@openmeetings.apache.org by "seba.wagner@gmail.com" <se...@gmail.com> on 2021/09/01 09:46:44 UTC

OpenMeetings Swagger online for API documentation [OPENMEETINGS-2420]

Hi,

I've updated the website and added an automatically generated swagger file
from our Rest Service:
https://openmeetings.apache.org/swagger/

The PR that adds this auto-generation from our WebService definition is
here:
https://github.com/apache/openmeetings/pull/146

There is still a bit of work to do:

   - Make sure each distribution of OpenMeetings also has the updated
   swagger file copied into it
   - Add the swagger-ui browser locally
   - Secure the URL locally by default (similar to what we do to the
   javaDoc, not sure if that is secured or not)

But rather I do that in another PR.

The website is updated, which is good, I think lots of people prefer
swagger to read and browse an API spec over reading a javaDoc these days.
Also you can use this swagger file to auto generate stubs using the
swagger-editor:
https://editor.swagger.io/?url=https://openmeetings.apache.org/swagger/appache-openmeetings-7.0.0-SNAPSHOT-swagger.json

There are probably later also lots of useful annotations that can be
added to make the documentation of our API better too. But that's all
future improvements to do later.

Thanks
Seb

Sebastian Wagner
Director Arrakeen Solutions, OM-Hosting.com
http://arrakeen-solutions.co.nz/
https://om-hosting.com - Cloud & Server Hosting for HTML5
Video-Conferencing OpenMeetings
<https://www.youracclaim.com/badges/da4e8828-743d-4968-af6f-49033f10d60a/public_url>
<https://www.youracclaim.com/badges/b7e709c6-aa87-4b02-9faf-099038475e36/public_url>