Pengecualian dan kode status HTTP

Halaman ini mencantumkan pengecualian yang disediakan oleh library endpoints serta kode status HTTP yang didukung oleh Cloud Endpoints Frameworks.

Dalam banyak situasi, Anda mungkin ingin menggunakan kode status HTTP umum untuk menunjukkan keberhasilan atau kegagalan permintaan API pengguna. Misalnya, jika pengguna berupaya mengambil entitas yang tidak ada, Anda mungkin ingin mengirim kode status HTTP 404 untuk menyatakan bahwa tidak ada entitas dengan ID: entityId.

Anda dapat mengirim kode status HTTP umum dengan memunculkan pengecualian yang disediakan oleh library endpoints sebagai berikut:

throw new NotFoundException(user.getEmail());

Pengecualian yang diberikan oleh Endpoints Frameworks

Endpoints Frameworks menyediakan pengecualian berikut, yang sesuai dengan kode status HTTP tertentu:

Pengecualian Kode status HTTP yang sesuai
com.google.api.server.spi.response.BadRequestException HTTP 400
com.google.api.server.spi.response.UnauthorizedException HTTP 401
com.google.api.server.spi.response.ForbiddenException HTTP 403
com.google.api.server.spi.response.NotFoundException HTTP 404
com.google.api.server.spi.response.ConflictException HTTP 409
com.google.api.server.spi.response.InternalServerErrorException HTTP 500
com.google.api.server.spi.response.ServiceUnavailableException HTTP 503

Kode status HTTP yang didukung

Framework Cloud Endpoints mendukung subset kode status HTTP dalam respons API. Tabel berikut menjelaskan kode yang didukung.

Kode status HTTP Dukungan
HTTP 2xx HTTP 200 biasanya diasumsikan oleh Endpoints Frameworks jika metode API berhasil ditampilkan.
Jika jenis respons metode API adalah void atau nilai yang ditampilkan oleh metode API adalah null , HTTP 204 akan ditetapkan.
HTTP 3xx Kode 3xx HTTP tidak didukung. Penggunaan kode HTTP 3xx akan menghasilkan respons HTTP 404.
HTTP 4xx Hanya kode HTTP 4xx berikut yang didukung:
  • 400
  • 401
  • 403
  • 404
  • 409
  • 410
  • 412
  • 413
Kode HTTP 4xx lainnya ditampilkan sebagai error 404, kecuali untuk kode berikut:
  • 405 ditampilkan sebagai 501
  • 408 ditampilkan sebagai 503
HTTP 5xx Semua kode status HTTP 5xx dikonversi menjadi HTTP 503 dalam respons klien.

Membuat class pengecualian Anda sendiri

Jika Anda ingin membuat class pengecualian lain untuk kode status HTTP lainnya, Anda harus membuat subclass com.google.api.server.spi.ServiceException. Cuplikan berikut menunjukkan cara membuat class pengecualian yang merepresentasikan kode status HTTP 408:

import com.google.api.server.spi.ServiceException;

// Exceptions must inherit from ServiceException
public class RequestTimeoutException extends ServiceException {
  public RequestTimeoutException(String message) {
    super(408, message);
  }
}

Menggunakan kode status HTTP yang tidak didukung

Anda dapat menggunakan kode status HTTP yang tidak ada dalam daftar yang didukung di atas. Perhatikan bahwa jika Anda memutuskan untuk melakukannya, hal ini dapat menimbulkan konsekuensi yang tidak diinginkan bagi library klien yang mengakses API. Untuk menggunakan kode error yang tidak didukung, buat class pengecualian Anda sendiri, seperti yang dijelaskan di bagian sebelumnya, dan tambahkan parameter inisialisasi servlet baru enableExceptionCompatibility ke EndpointsServlet:

  <servlet>
    <servlet-name>com.google.api.server.spi.EndpointsServlet</servlet-name>
    <servlet-class>com.google.api.server.spi.EndpointsServlet</servlet-class>
    <init-param>
      <param-name>services</param-name>
      <param-value>...</param-value>
    </init-param>
    <init-param>
      <param-name>enableExceptionCompatibility</param-name>
      <param-value>true</param-value>
    </init-param>
  </servlet>