api response

CoreJsonResponse

CoreJsonResponse JSON 応答特性。この特性により、どのコントローラーでも適切な HTTP ステータス コードを含む JSON 応答を簡単に返すことができます。

Composer 経由でインストールする

 composer require aelnemr/api-response

使用法

必要なのは、コントローラー内でCoreJsonResponseトレイトuseだけです。

例：

 <?php
namespace App  Http  Controllers ;

use Illuminate  Http  Request ;
use AElnemr  RestFullResponse  CoreJsonResponse ;

class CountryController extends Controller
{
    use CoreJsonResponse;

    public function index ()
    {
        $ data =  App User:: get ();
        return $ this -> ok ( $ data );
    }
}

利用可能な方法

成功方法 ✌️

方法	ステータスコード	説明
わかりました	200	取得、パッチの成功 (JSON オブジェクトを返す)
okWithページネーション	200	取得、パッチの成功 (JSON オブジェクトを返す)
作成されました	201	成功した投稿 (JSON オブジェクトを返す)

エラーステータス?

方法	ステータスコード	説明
認証されていない	401	エラーが認証されていません
禁断	403	エラー 権限がありません (認証されていますが、権限がありません)
見つかりません	404	エラーが見つかりませんでした
無効なリクエスト	422	エラーの検証

追加のメソッド?

方法	ステータスコード	説明
受け入れられました	202	成功した投稿、削除、パス - 非同期
要求の形式が正しくありません	400	エラー 構文が正しくないため、リクエストをサーバーが理解できませんでした
お支払い必須	402	エラー 支払いが必要です
対立	409	エラー 論理エラー