как я могу определить описание параметров URL в «mpociot / laravel-apidoc-generator»: пакет «^ 2.1»

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