tipitaka.php 3.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. <?php
  2. /*
  3. |--------------------------------------------------------------------------
  4. | v3 · tipitaka —— 三藏相关的功能块
  5. |--------------------------------------------------------------------------
  6. |
  7. | 由 routes/api.php 的 v3 组 require 进来,前缀已在那边加好。
  8. |
  9. | **路径开头是「领域-功能」,不是资源坐标。** `channel + book + para` 在 wikipali
  10. | 里是通用坐标(sentences / wbw / 批注 / 进度全都用它),放在路径开头会让每个新
  11. | 能力来抢同一个前缀,而且看不出这条 API 干什么。所以是
  12. | `/v3/tipitaka-reading/{channel}?book=&para=`,不是 `/v3/channels/{c}/books/{b}/…`。
  13. |
  14. | 路由判据(见根目录 CLAUDE.md):
  15. | - 必填参数进路径,可选参数留查询串
  16. | - 路径变量最多两个,能做到一个最好;多出来的想办法降成 filter
  17. |
  18. */
  19. use App\Http\Controllers\V3\TipitakaChapterChannelController;
  20. use App\Http\Controllers\V3\TipitakaChapterController;
  21. use App\Http\Controllers\V3\TipitakaDiscussionController;
  22. use App\Http\Controllers\V3\TipitakaReadingController;
  23. use App\Http\Controllers\V3\TipitakaRelatedParagraphAggregateController;
  24. use App\Http\Controllers\V3\TipitakaRelatedParagraphController;
  25. use Illuminate\Support\Facades\Route;
  26. // 只有 channel 必填,所以路径上只有它一个变量;book / chapter / para 全是 filter。
  27. // 不带任何查询串 = 取这个 channel 的全部译文,下载场景要的就是这个。
  28. Route::get('tipitaka-reading/{channel}', TipitakaReadingController::class)
  29. ->whereUuid('channel');
  30. // 一段经文里的讨论:同样只有 channel 必填;book / chapter / para / to 与 type 等都是 filter。
  31. // 与 /v3/discussions(按单个对象查)必填参数不同,是另一个契约。
  32. Route::get('tipitaka-discussions/{channel}', TipitakaDiscussionController::class)
  33. ->whereUuid('channel');
  34. // 一章有哪些 channel 及其完成度(原 v2 progress?view=chapter_channels)。book、para 都必填,进路径。
  35. Route::get('tipitaka-chapter-channels/{book}/{para}', TipitakaChapterChannelController::class)
  36. ->whereNumber(['book', 'para']);
  37. // 章节标题:按名字找章节(容错),或列出一本书的全部标题(原 v2 search-title-index)。q / book 至少给一个,都是过滤条件。
  38. Route::get('tipitaka-chapters', TipitakaChapterController::class)
  39. ->name('tipitaka-chapters.index');
  40. // 段落关联关系:查询(原 v2 related-paragraph)+ 聚合(book_name 列表 / 某 book_name 的 cs_para)。
  41. Route::get('tipitaka-related-paragraphs/aggregate', [TipitakaRelatedParagraphAggregateController::class, 'index'])
  42. ->name('tipitaka-related-paragraphs.aggregate');
  43. Route::get('tipitaka-related-paragraphs/aggregate/{book_name}', [TipitakaRelatedParagraphAggregateController::class, 'show'])
  44. ->name('tipitaka-related-paragraphs.aggregate.show');
  45. Route::get('tipitaka-related-paragraphs', [TipitakaRelatedParagraphController::class, 'index'])
  46. ->name('tipitaka-related-paragraphs.index');