Download the PHP package wfgm5k2d/phplightdoc without Composer

On this page you can find all versions of the php package wfgm5k2d/phplightdoc. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of wfgm5k2d/phplightdoc

Informations about the package phplightdoc

Laravel API Documentation Generator

LaravelAPI Docs

This package automatically analyzes Laravel controllers and routes, extracting information about groups, names, middleware, response codes, and generating user-friendly documentation in JSON format.

📦 Installation

📦 Publish all files

Configure environment variables

🚀 Usage

After installation, a command to generate documentation will appear in Laravel:

The documentation will be saved in the file specified in .env and will be available in the browser at the /doc route.

📝 Annotations and attributes

You can additionally annotate controllers and methods for a more accurate API description.

Controller Grouping

Groups help structure the documentation into thematic sections.

Simple grouping

You can give a name to a controller group. All routes of this controller will fall into the specified group.

Via comment:

Or attribute:

🆕 Advanced grouping (nested groups)

You can also create top-level groups to combine multiple controllers. To do this, you need to pass a second parameter to the DocGName attribute — the name of the main group.

Via attribute:

This allows you to create a more complex and convenient documentation structure.

Route Description

You can set a clear name for the route:

Via comment:

Or attribute:

Middleware Requirements

If a method requires authorization or special headers, specify it explicitly.

Via comment:

Or attribute:

By default, the following set of middleware is checked: auth, throttle, can, requires.

Response Codes

The package searches for response codes in these constructs:

By default, the response code will be 200 if no others are specified.

You can manually specify the available response codes if they are not detected

Via comment:

Or attribute:

🔄 Generating and viewing documentation

Run the generation command:

Open /doc in your browser to view.

How to develop the package locally?

Laravel <= 10v.

Laravel >= 11v.

All versions of phplightdoc with dependencies

PHP Build Version
Package Version
Requires php Version >=7.4
illuminate/support Version >=8.0
nikic/php-parser Version ^5.6
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package wfgm5k2d/phplightdoc contains the following files

Loading the files please wait ...