guglielmoseminara/laravel-apidoc-generator

Composer 安装命令：


                            composer require guglielmoseminara/laravel-apidoc-generator

包简介

Generate beautiful API documentation from your Laravel application

关键字：

#documentation #api #laravel

README 文档

README

Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes. Here's what the output looks like.

php artisan apidoc:generate

Installation

PHP 7 and Laravel 5.5 or higher are required.

composer require mpociot/laravel-apidoc-generator

Laravel

Publish the config file by running:

php artisan vendor:publish --provider="Mpociot\ApiDoc\ApiDocGeneratorServiceProvider" --tag=apidoc-config

This will create an apidoc.php file in your config folder.

Lumen

$app->register(\Mpociot\ApiDoc\ApiDocGeneratorServiceProvider::class);

Copy the config file from vendor/mpociot/laravel-apidoc-generator/config/apidoc.php to your project as config/apidoc.php. Then add to your bootstrap/app.php:

$app->configure('apidoc');

Documentation

Check out the documentation at ReadTheDocs.

License

The Laravel API Documentation Generator is free software licensed under the MIT license.

guglielmoseminara/laravel-apidoc-generator 适用场景与选型建议

guglielmoseminara/laravel-apidoc-generator 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 81 次下载、GitHub Stars 达 0，最近一次更新时间为 2020 年 05 月 05 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「documentation」「api」「laravel」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 guglielmoseminara/laravel-apidoc-generator 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 guglielmoseminara/laravel-apidoc-generator 我们能提供哪些服务？

定制开发 / 二次开发

基于 guglielmoseminara/laravel-apidoc-generator 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发