如何在“mpociot/laravel-apidoc-generator”: “^2.1” 包中定义 url 参数的描述

Question

如何定义 url 参数的描述？

我想使用 laravel 5.4 和 "mpociot/laravel-apidoc-generator": "^2.1" 包。

如图所示。

Answer 1

您可以像这样使用 bodyParam 注释：

/**
 * Database authentication
 *
 * @bodyParam email string required Email address.
 * @bodyParam password string required Users password.
 * @param UserAuthenticationRequest $request
 * @return JsonResponse
 * @response JsonResponse
 * @throws AuthenticationException
 */
public function authenticate(UserAuthenticationRequest $request): JsonResponse {
...
}

有关详细信息，请阅读 laravel apidoc generator docs

如何在“mpociot/laravel-apidoc-generator”: “^2.1” 包中定义 url 参数的描述

how I can define the description of url parameters in “mpociot/laravel-apidoc-generator”: “^2.1” package

php

laravel

laravel-5.4