Download the PHP package owowagency/automated-api-docs without Composer

On this page you can find all versions of the php package owowagency/automated-api-docs. 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 owowagency/automated-api-docs

Informations about the package automated-api-docs

Auto generated documentation for APIs

Installation

Installation and setup time is estimated to be around 5 to 10 minutes. Install this package via composer.

If you're using Laravel >= 5.5 this package will automatically be added to your providers list. If using a lower version, add the service provider to the providers array in config/app.php.

You're now ready for setup.

The package comes with a config file. The default config should be good in most use cases. However, feel free to change it. To publish the config file run the following command

Setup

After installation, and optionally configuration, we need to setup the package. The package usage a hook in the HTTP calls to your app via the feature tests to monitor all requests and responses.

Firstly, you need to use the trait to enable to monitor hook.

Secondly, you need to register a shutdown function so that the package now when to parse the docs into a custom format which is readable for the parsers.

Next, you need to add this file to the root of your Laravel application. If this file already exists in your app you probably only need to copy the documentation task.

Finally, make sure to add the following command envoy run documentation in your deployment script. For example on Laravel Forge.

You're now ready to register all the monitor hooks. You can do that by calling the monitor() method before calling a route.

All versions of automated-api-docs with dependencies

PHP Build Version
Package Version
Requires php Version ^7.0
illuminate/support Version 5.*|^6.0|^7.0|^8.0
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 owowagency/automated-api-docs contains the following files

Loading the files please wait ....