SearchSuggestionController.php 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. <?php
  2. namespace App\Http\Controllers\V3;
  3. use App\Http\Controllers\Controller;
  4. use App\Http\Requests\V3\IndexSearchSuggestionRequest;
  5. use App\Http\Resources\V3\SearchSuggestionResource;
  6. use App\Services\V3\SearchService;
  7. /**
  8. * 搜索建议(搜索框的前缀补全,OpenSearch completion suggester)
  9. *
  10. * 取代早期的 `GET /v3/search-suggest`(`V3\SearchSuggestController`,2026-11-19 删除):
  11. * 路径复数化;`{success, data:{query, suggestions, total}}` 改成 `{data, meta}`;空 q 从 400 改 422;
  12. * `limit` 从「每个字段各取」改成总条数并去重;去掉从未生效的 `language` 参数。
  13. * 无对应的 v2 端点。
  14. */
  15. class SearchSuggestionController extends Controller
  16. {
  17. public function __construct(private readonly SearchService $search) {}
  18. /**
  19. * 搜索建议
  20. *
  21. * 按已输入的前缀给出补全候选,各字段合并后按分数排序、同一个词只出现一次。
  22. * 搜索服务连不上或超时回 503(`search-unavailable`)。
  23. *
  24. * @unauthenticated
  25. *
  26. * @queryParam q string required 已输入的前缀
  27. * @queryParam fields string 在哪些字段上补全,逗号分隔,可选 title_pali、title_zh、content_pali、content_zh;不传则全部。Example: title_pali,content_pali
  28. * @queryParam limit integer 最多返回几条,上限 50。Default: 10
  29. *
  30. * @responseStatus 503 搜索服务暂不可用
  31. *
  32. * @meta total integer 本次返回的条数
  33. */
  34. public function __invoke(IndexSearchSuggestionRequest $request)
  35. {
  36. $items = $this->search->suggest($request->validated());
  37. return SearchSuggestionResource::collection($items)->additional(['meta' => ['total' => count($items)]]);
  38. }
  39. }