推荐一个 自动生成Laravel 文档的 组件

下载与安装部分

# 安装
composer require --dev knuckleswtf/scribe

# 生成文档
php artisan scribe:generate

其他

  • 官方文档
  • 关于生成文档的注解 是我比较喜欢这个组件的 一点, 比如这样
    #[Group('授权相关', '关于应用授权部分内容')]
    class AuthController extends BaseController
    {
      /**
       * 登录
       * @param AdminAuthRequest $request
       * @param UserService $userService
       * @return JsonResponse
       */
      public function login(AdminAuthRequest $request,
                            UserService $userService): JsonResponse
      {
          return success($userService->login($request->user()));
      }
    }

效果

推荐一个 自动生成Laravel 文档的 组件

本作品采用《CC 协议》,转载必须注明作者和本文链接
i@llons.com
《L03 构架 API 服务器》
你将学到如 RESTFul 设计风格、PostMan 的使用、OAuth 流程,JWT 概念及使用 和 API 开发相关的进阶知识。
《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
讨论数量: 2

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!