ガイド

イントロダクション

Orion for Laravelのドキュメントへようこそ。

仕組み

Orionは、Eloquentモデルとリレーション、ポリシー、リクエストクラス、APIリソースといったLaravelの最も強力な機能を活用しています。そのため、非常に強力で拡張性が高い一方で、簡単に使い始めることができます。

コントローラーを作成し、APIで管理したいEloquentモデルに関連付けるだけで、残りの処理はOrionが引き受けます。indexsearchshowstoreupdatedestroyrestoreおよびbatchStorebatchUpdatebatchDestroybatchRestoreの各操作のエンドポイントが、適切な認可、バリデーション、エラー処理とともに最初から用意されています(もちろん、ポリシーとリクエストクラスは自分で定義する必要があります)。

しかし、それだけではありません。リレーションコントローラーを定義すれば、APIの利用者はあらゆる種類のリレーションを管理できるようになります。文字どおりすべて、つまりCRUD操作に加えてassociate/dissociateattach/detachsynctoggleupdatePivotが、標準化されたREST APIを通じて利用できます。

さらに、モデルコントローラーとリレーションコントローラーの両方のsearchエンドポイントでは、さまざまなクエリ制約を適用して、フィルタリングされた結果を取得できます。

機能