主页 / 问题 / 867708
Accepted
Hardc0re
Asked:2020-08-12 19:56:12 +0800 CST2020-08-12 19:56:12 +0800 CST

全自动生成 API 文档

  • 772

我在项目中使用https://github.com/mpociot/laravel-apidoc-generator 来创建文档。

出现了几个问题。

  • 不显示请求参数中数组元素的验证规则，即

    'array.*.item' => 'required|bool'

  • 不显示字段的自定义规则，尽管该方法 __toString在规则本身中进行了描述。

关于第一个问题 - 在这个文件中，该方法getParameters接收来自验证器的参数，但除了数组元素的规则之外的所有内容。

如何强制验证器返回为路由描述的所有规则？

php

1 个回答

  1. Best Answer

    等等从请求中显示数组元素的问题：去掉了验证器，我们直接从路由中获取验证规则，添加了一个与验证器类比的打破规则的方法：

    $validatorRules = $this->getRules($this->getRouteRules($routeAction['uses'], $bindings));

    为了解决第二个问题，我添加了几个自定义类型（custom_string、custom_integer、custom_boolean、custom_date），它们可以通过在方法中描述自定义规则来使用__toString，例如

    custom_string:Custom rule description

    制作了一个解决这些问题的叉子。

    https://github.com/mykolaivashchuk/laravel-apidoc-generator

    • 0

相关问题