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:

Kode status HTTP yang didukung

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

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>