Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Stop the Tomcat server (if it was alrewady started).
  • Download the Rest tools bundle 
    Artifact resource link
    groupIdinfo.magnolia.rest
    artifactIdmagnolia-rest-tools
    label$artifactId.zip
    renderTypedownload_link
    versionSNAPSHOT
    resourceTypeZIP
    .
  • Unzip the download and copy* all the files to 
    • $tomcat/webapps/magnoliaAuthor/WEB-INF/libs
    • $tomcat/webapps/magnoliaPublic/WEB-INF/libs (if the direcory already exists).

*) The zip file may contain .jar files which are already present in the WEB-INF/libs folder of your webapps.

Set the Swagger API base path

Multiexcerpt
MultiExcerptNamesetting-swagger-base-path

The Swagger API explorer tool searches for the API at a path set in /modules/rest-tools/config/apiBasepath. The default value is http://localhost:8080/.rest. The value for this property must match the following pattern:

Code Block
languageerl
<protocol>://<hostname>:<port>/<context>/.rest

When using one of Magnolia's preconfigured bundles running on localhost, set the property to  http://localhost:8080/magnoliaAuthor/.rest.

Set the path to where REST services reside on your system. If you run the standard Magnolia bundle and work on the author instance, set the path to http://localhost:8080/magnoliaAuthor/.rest.

Advanced Tables - Table Plus
enableHeadingAttributesfalse
enableSortingfalse
classm5-configuration-tree
enableHighlightingfalse


Node nameValue

Mgnl f
modules


Mgnl f
rest-tools


Mgnl f
config


Mgnl p
apiBasepath

http://localhost:8080/magnoliaAuthor/.rest


After setting the base path, restart Magnolia.

Swagger is in Dev > REST Tools.

Setup with a Magnolia for beginners - step by step

...