Skip to content

A shopware next plugin to get a readable documentation for all the routes.

License

Notifications You must be signed in to change notification settings

niemand-online/NoRouteDocumentation

Repository files navigation

NoRouteDocumentation

Because there is no REST documentation yet

Installation

  1. Unpack into /custom/plugins/NoRouteDocumentation
  2. bin/console plugin:update - Update plugin list
  3. bin/console plugin:install NoRouteDocumentation - Install plugin
  4. bin/console plugin:activate NoRouteDocumentation - Activate plugin

Usage

You can execute the new command no:routes:serialize. You have to specify the target export format. Accepted formats are:

Format key Description
json:basic Simple json serialization of the route classes
json:detail A detailed json serialization of the route classes

You can define a file to write the serialization into.

License

Have look at the shipped LICENSE file. In short LGPL v3.0.

About

A shopware next plugin to get a readable documentation for all the routes.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published