ObsÅ‚uga bÅ‚Ä™dów ¶

Podczas obsługi żądania RESTfulowego API, w przypadku wystąpienia błędu w zapytaniu użytkownika lub gdy stanie się coś nieprzewidywanego z serwerem, możesz po prostu rzucić wyjątkiem, aby powiadomić użytkownika, że coś poszło nieprawidłowo. Jeśli możesz zidentyfikować przyczynę błędu (np. żądany zasób nie istnieje), powinieneś rozważyć rzucenie wyjątkiem razem z odpowiednim kodem statusu HTTP (np. NotFoundHttpException odpowiada statusowi o kodzie 404). Yii wyśle odpowiedź razem z odpowiadającym jej kodem i treścią statusu HTTP. Yii dołączy również do samej odpowiedzi zserializowaną reprezentację wyjątku. Przykładowo:

HTTP/1.1 404 Not Found
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

{
    "name": "Not Found Exception",
    "message": "The requested resource was not found.",
    "code": 0,
    "status": 404
}

Poniższa lista zawiera kody statusów HTTP, które są używane przez Yii REST framework:

• 200: OK. Wszystko dziaÅ‚a w porzÄ…dku.
• 201: Zasób zostaÅ‚ poprawnie stworzony w odpowiedzi na żądanie POST. Nagłówek Location zawiera URL kierujÄ…cy do nowoutworzonego zasobu.
• 204: Żądanie zostaÅ‚o poprawnie przetworzone, ale odpowiedź nie zawiera treÅ›ci (jak w przypadku żądania DELETE).
• 304: Zasób nie zostaÅ‚ zmodyfikowany. Można użyć wersji przetrzymywanej w pamiÄ™ci podrÄ™cznej.
• 400: NieprawidÅ‚owe żądanie. Może być spowodowane przez wiele czynników po stronie użytkownika, takich jak przekazanie nieprawidÅ‚owych danych JSON, nieprawidÅ‚owych parametrów akcji, itp.
• 401: Nieudana autentykacja.
• 403: Autoryzowany użytkownik nie ma uprawnieÅ„ do danego punktu koÅ„cowego API.
• 404: Żądany zasób nie istnieje.
• 405: Niedozwolona metoda. Sprawdź nagłówek Allow, aby poznać dozwolone metody HTTP.
• 415: Niewspierany typ mediów. Żądany typ zawartoÅ›ci lub numer wersji jest nieprawidÅ‚owy.
• 422: Nieudana walidacja danych (dla przykÅ‚adu w odpowiedzi na żądanie POST). Sprawdź treść odpowiedzi, aby poznać szczegóły bÅ‚Ä™du.
• 429: Zbyt wiele żądaÅ„. Żądanie zostaÅ‚o odrzucone z powodu osiagniÄ™cia limitu użycia.
• 500: WewnÄ™trzny bÅ‚Ä…d serwera. To może być spowodowane wewnÄ™trznymi bÅ‚Ä™dami programu.

Modyfikowanie bÅ‚Ä™dnej odpowiedzi ¶

Czasem wymagane może być dostosowanie domyślnego formatu błędnej odpowiedzi. Dla przykładu, zamiast używać różnych statusów HTTP dla oznaczenia różnych błędów, można serwować zawsze status 200 i dodawać prawidłowy kod statusu HTTP jako część struktury JSON w odpowiedzi, jak pokazano to poniżej:

HTTP/1.1 200 OK
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

{
    "success": false,
    "data": {
        "name": "Not Found Exception",
        "message": "The requested resource was not found.",
        "code": 0,
        "status": 404
    }
}

Aby osiÄ…gnąć powyższy efekt, należy skonfigurować odpowiedź na event beforeSend dla komponentu response w aplikacji:

return [
    // ...
    'components' => [
        'response' => [
            'class' => 'yii\web\Response',
            'on beforeSend' => function ($event) {
                $response = $event->sender;
                if ($response->data !== null && Yii::$app->request->get('suppress_response_code')) {
                    $response->data = [
                        'success' => $response->isSuccessful,
                        'data' => $response->data,
                    ];
                    $response->statusCode = 200;
                }
            },
        ],
    ],
];

Powyższy kod zreformatuje odpowiedź (zarówno typu sukces jak i bÅ‚Ä…d), kiedy suppress_response_code zostanie przekazane jako parametr GET.