I would vote to have swagger at https://openmeetings.apache.org/swagger/ only I see no benefit in shipping it with every build
we can add some instructions to docs on how to add personal UI I'm still not sure how swagger can help, and why it is better than javadoc :) On Thu, 2 Sept 2021 at 04:25, [email protected] <[email protected]> wrote: > Hi, > > as for the generated swagger API definition, there are a few options on how > to ship it with every distribution of OpenMeetings: > > 1) Just include the raw openapi json and yaml file. If somebody wants to > browse the spec they have to use their own swagger editor. > 2) Include the swagger-ui in each distribution so that the openapi json and > yaml are browsable same as https://openmeetings.apache.org/swagger/ (would > become something like http://localhost:5080/openmeetings/swagger) on each > local machine > > (2) is more neat and what most projects do. > > However with (2) there are a few challenges: > A) The swagger UI is ~5MB in HTML/JS/CSS. We can include it but it will add > to the distribution zip/tar.gz file. It will be probably much less (~1MB) > once its zipped up. > B) I will need to write some sort of task that pulls the latest version of > the swagger UI from github or NPM (otherwise I would need to check in the > UI artifacts into our repo, which makes our repository slower and larger) > C) We need to be able to disable the access to the swagger UI URL. In > production environments people shouldn't expose the API docs publicly > > We can do (2), I just want to make sure we understand A, B, C. Cause that > will be a few changes to add. > > Thanks, > Sebastian > > 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 > > > -- Best regards, Maxim
