Laravel API 文档生成器生成指定的 API 文档

从现有的Laravel / Lumen / Dingo路线自动生成API文档

--安装过程就不再这里说了可以参照github的安装说明或者Laravel学院同学的文章

重点说一下如何生成自己想要生成的文档部分:

先看一下官方的介绍

  • 该包提取所有应用程序的路由。
  • 它会查看您的配置文件,以过滤您实际要记录的路由。对于每个路径,它会检索您要应用于它的设置(如果有)。
  • 它处理每条路线。这里的“过程”涉及使用多种策略来提取路线的信息:组,标题,描述,身体参数,查询参数和样本响应(如果可能)。
  • 处理完路径后,它会生成一个markdown文件,描述来自解析数据的路径并将它们传递给Documentarian,后者将它们包装在一个主题中并将它们转换为HTML和CSS。
  • 它为您的路线生成Postman API集合。(可以禁用此功能。

回到问题再来看
--需要在你的app/apidoc.php中配置如下

                'prefixes' => [
                    '你的路由文件名称/*',
                    // 'users/*',
                ],

然后再根目录执行

php artisan api:generate

即可将你指定的路由文件下的所有路由生成对应的文档,官方提供的文档很全需要其他配置的同学请仔细阅读文档,如果我的文章有错误欢迎同学踊跃指出。

《L01 基础入门》
我们将带你从零开发一个项目并部署到线上,本课程教授 Web 开发中专业、实用的技能,如 Git 工作流、Laravel Mix 前端工作流等。
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!