Versions Compared

Old Version 1

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version Current

changes.mady.by.user Christoph Meier

Saved on

Key

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


Multiexcerpt
MultiExcerptNamegeneral_info

The Swagger framework is supported by a set of core tools for designing, building, and documenting RESTful APIs.

Source: https://swagger.io/tools/

Magnolia provides integration with Swagger tools directly in the Admin UI.

Info

Swagger tools are for development and testing purposes only.

To test your endpoints with Swagger:

  • Add the magnolia-rest-tools module to your webapp.
  • Set the Swagger API base path.
  • Use the Swagger annotations in your endpoint class.
  • Use the app within the Magnolia Admin UI to test your endpoints.

Installing the module

Make sure the magnolia-rest-tools module is part of your webapp. See recommended dependencies above about how to manage Swagger integration with Maven.

...



...

_set the API base path