Download the PHP package alagiesinghateh/laravel-docmaker without Composer

On this page you can find all versions of the php package alagiesinghateh/laravel-docmaker. 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 alagiesinghateh/laravel-docmaker

Informations about the package laravel-docmaker

Laravel API Doc Generator

Issues Latest Version License Stars Total Downloads

A powerful Laravel package that automatically generates comprehensive API documentation from your controller annotations. Supports API Blueprint format with intelligent annotation parsing, authentication detection, and smart backup system.

✨ Features

📦 Installation

Install via Composer:

Publish the configuration file:

Publish the views (optional):

⚙️ Configuration

After publishing the config file, you can modify config/api-doc-generator.php:

🚀 Usage

Generate API Documentation

Regenerate Controller Annotations

Backup Management

📖 Annotation Reference

Basic Annotation Structure

Supported Annotations

Annotation Description Example
@api HTTP method and endpoint @api {GET} /api/users Get Users
@apiName Endpoint name @apiName GetUsers
@apiGroup Group/category @apiGroup User
@apiDescription Endpoint description @apiDescription Get all users
@apiParam Request parameter @apiParam {String} name User name
@apiHeader Request header @apiHeader {String} Authorization Bearer token
@apiSuccess Success response field @apiSuccess {Number} id User ID
@apiError Error response @apiError {401} Unauthorized
@apiAuth Authentication type @apiAuth bearer
@apiMiddleware Middleware used @apiMiddleware auth:api
@apiPermission Required permissions @apiPermission users.read,users.write

🛡️ Security

The package includes built-in security features:

Production Environment

Development Environment

Configuration Example

🔧 Advanced Usage

Custom Controller Properties

Manual Annotation Overrides

Integration with Form Requests

🌐 Web Interface

Access the web interface at:
http://your-app.com/api-docs

![API Documentation Interface]

Customizing the Web Interface

Publish the views and modify them as needed:

Views will be published to:
resources/views/vendor/api-doc-generator/

🔄 Backup System

The package includes a smart backup system:

🧪 Testing

Run the package tests:

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This package is open-source software licensed under the MIT license.

🐛 Bug Reports

If you discover any bugs, please create an issue on GitHub.

📞 Support

For support and questions:

🙏 Acknowledgments

Note: This package is actively maintained. For the latest updates and features, always check the GitHub repository.

All versions of laravel-docmaker with dependencies

PHP Build Version
Package Version
Requires php Version ^8.2
illuminate/support Version ^10.0|^11.0|^12.0
illuminate/console Version ^10.0|^11.0|^12.0
illuminate/filesystem Version ^10.0|^11.0|^12.0
guzzlehttp/guzzle Version ^7.5
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 alagiesinghateh/laravel-docmaker contains the following files

Loading the files please wait ...