This is an automated email from the ASF dual-hosted git repository. sebawagner pushed a commit to branch feature/OPENMEETINGS-2420-generate-swagger-and-provide-to-users-using-swagger-ui in repository https://gitbox.apache.org/repos/asf/openmeetings.git
commit 595e2afe6611bc2bc855a0542fb0137a15b8d2f5 Author: Sebastian Wagner <[email protected]> AuthorDate: Wed Sep 1 21:36:01 2021 +1200 OPENMEETINGS-2420 GEnerates swagger and update generated website to link swagger doc. --- openmeetings-server/src/site/resources/js/site.js | 2 +- openmeetings-server/src/site/site.xml | 3 +- openmeetings-webservice/pom.xml | 35 +++++++++++++++++++++++ 3 files changed, 38 insertions(+), 2 deletions(-) diff --git a/openmeetings-server/src/site/resources/js/site.js b/openmeetings-server/src/site/resources/js/site.js index ae81eef..328a711 100644 --- a/openmeetings-server/src/site/resources/js/site.js +++ b/openmeetings-server/src/site/resources/js/site.js @@ -19,7 +19,7 @@ */ $(document).ready(function() { // "New" markers - var topics = ["Call For Logo"]; + var topics = ["Call For Logo", "REST API Swagger"]; for (var i = 0; i < topics.length; ++i) { $('ul.nav li a[title="' + topics[i] + '"').append(' <span class="badge badge-success">New</span>') } diff --git a/openmeetings-server/src/site/site.xml b/openmeetings-server/src/site/site.xml index 5a27a60..73e9926 100644 --- a/openmeetings-server/src/site/site.xml +++ b/openmeetings-server/src/site/site.xml @@ -43,7 +43,8 @@ </menu> <menu name="Configuration"> <item name="Integration" href="#integration"> - <item name="SOAP/REST API" href="/openmeetings-webservice/apidocs/index.html" target="_blank"/> + <item name="REST API Swagger" href="/swagger" target="_blank"/> + <item name="SOAP/REST API JavaDoc" href="/openmeetings-webservice/apidocs/index.html" target="_blank"/> <item name="REST API Sample" href="/RestAPISample.html" /> <item name="Ldap and ADS" href="/LdapAndADS.html" /> <item name="OAuth2" href="/oauth2.html" /> diff --git a/openmeetings-webservice/pom.xml b/openmeetings-webservice/pom.xml index e46d0d4..9de4cba 100644 --- a/openmeetings-webservice/pom.xml +++ b/openmeetings-webservice/pom.xml @@ -56,6 +56,41 @@ </execution> </executions> </plugin> + <plugin> + <groupId>io.openapitools.swagger</groupId> + <artifactId>swagger-maven-plugin</artifactId> + <configuration> + <resourcePackages> + <resourcePackage>org.apache.openmeetings.webservice</resourcePackage> + </resourcePackages> + <outputDirectory>${basedir}/target/</outputDirectory> + <outputFilename>appache-openmeetings-${project.version}-swagger</outputFilename> + <outputFormats>JSON,YAML</outputFormats> + <prettyPrint>true</prettyPrint> + <swaggerConfig> + <info> + <title>Apache OpenMeetings API</title> + <version>${project.version}</version> + <contact> + <email>[email protected]</email> + <name>Apache OpenMeetings Developer group</name> + <url>https://openmeetings.apache.org</url> + </contact> + <license> + <url>https://www.apache.org/licenses/LICENSE-2.0</url> + <name>The Apache Software License, Version 2.0</name> + </license> + </info> + </swaggerConfig> + </configuration> + <executions> + <execution> + <goals> + <goal>generate</goal> + </goals> + </execution> + </executions> + </plugin> </plugins> </build> <dependencies>
