larafly / apidoc
this is for laravel api document
Fund package maintenance!
apidoc
Requires
- php: ^8.2
- illuminate/contracts: ^10.0||^11.0||^12.0
Requires (Dev)
- larastan/larastan: ^2.9||^3.0
- laravel/pint: ^1.14
- nunomaduro/collision: ^8.1.1||^7.10.0
- orchestra/testbench: ^10.0.0||^9.0.0||^8.22.0
- pestphp/pest: ^3.0
- pestphp/pest-plugin-arch: ^3.0
- pestphp/pest-plugin-laravel: ^3.0
- phpstan/extension-installer: ^1.3||^2.0
- phpstan/phpstan-deprecation-rules: ^1.1||^2.0
- phpstan/phpstan-phpunit: ^1.3||^2.0
README
Laravel Apidoc
中文文档
Laravel Apidoc is an API documentation generation tool based on Laravel.
Installation
Install via Composer:
composer require larafly/apidoc
Run the following command to install the documentation tool:
php artisan apidoc:install
Now you can access Laravel Apidoc
at http://localhost:8000/apidoc
in your application.
Configuration File
Publish the configuration file:
php artisan vendor:publish --tag=larafly-apidoc
Explanation of the larafly-apidoc.php
file:
<?php return [ // API documentation access route 'route' => env('API_DOC_ROUTE', 'apidoc'), // Date format 'datetime_format' => 'Y-m-d H:i:s', // Author of the API documentation 'author' => env('GENERATOR_AUTHOR', 'system'), // Show documentation in production, default is false 'is_show' => env('API_DOC_SHOW', false), ];
Set GENERATOR_AUTHOR=Your Name
in your .env
file to configure the author.
Generate Request
Use the command line to generate a Request class:
php artisan apidoc:request UserRequest
If your class extends the pagination base class PageApiRequest
, you can add the --p
option:
php artisan apidoc:request UserRequest --p
Generate Response
Use the command line to generate a Response class:
php artisan apidoc:response UserResponse
If your class extends the paginated response class PaginateResponse
, you can add the --p
option:
php artisan apidoc:response UserResponse --p
Generation Commands
- Write documentation to the database. Run the following command:
php artisan apidoc
After generation, visit http://localhost:8000/apidoc
to view the documentation.
If the generated result is incorrect, check whether the API configuration is properly defined.
- Write documentation to a
markdown
file. Run the following command:
php artisan apidoc:md
After generation, go to storage/app/public/apidoc
to view the generated documentation files.
Changelog
View the changelog for update history.
MIT. Please see the license file for more information.