Membuat Endpoint

Endpoint adalah blok penyusun fundamental API di Apidog. Panduan ini memperkenalkan cara membuat dan menentukan endpoint, membantu Anda mendefinisikan spesifikasi API secara efektif.

Apa itu Endpoint?

Endpoint merepresentasikan satu operasi API yang dapat dipanggil melalui HTTP. Setiap endpoint terdiri dari:

Komponen	Deskripsi	Contoh
Metode HTTP	Tindakan yang akan dilakukan	`GET`, `POST`, `PUT`, `DELETE`
Path	Path URL relatif terhadap URL dasar	`/users/{id}`
Parameter	Parameter path, query, header, atau body	`id` (parameter path)
Body Permintaan	Data yang dikirim bersama permintaan (untuk POST/PUT)	Skema JSON
Respons	Format respons dan kode status yang diharapkan	`200 OK`, `404 Not Found`

Konsep Utama

Endpoint Apidog digerakkan oleh spesifikasi. Saat Anda mendefinisikan endpoint, Anda membuat dokumentasi sekaligus antarmuka yang dapat diuji dan secara otomatis menghasilkan permintaan.

Prasyarat

Sebelum membuat endpoint, pastikan Anda memiliki:

Akun Apidog dan aplikasi klien Apidog

Pemahaman dasar tentang metode HTTP dan konsep API

Proyek yang telah dibuat di Apidog tempat Anda ingin menambahkan endpoint; lihat halaman Ikhtisar untuk informasi lebih lanjut.

Mulai Cepat: Pembuatan Endpoint Dasar

Navigasi ke Modul APIs: Klik tab "APIs" di sidebar

Buat Endpoint Baru:

Klik tombol New HTTP Endpoint atau + di pohon direktori, lalu New HTTP Endpoint

Pilih modul/folder target

Tindakan ini menempatkan Anda dalam Design-first Mode (atau Anda dapat melakukannya secara manual sebelum membuat permintaan), tempat Anda mendefinisikan spesifikasi API terlebih dahulu.

Metode Pembuatan Endpoint

Metode	Kapan Digunakan	Langkah-langkah
Pembuatan Manual	Memulai dari awal	1. Klik kanan folder → "New Endpoint" 2. Isi metode dan path 3. Definisikan parameter dan respons
Impor dari Kode	Kode API yang sudah ada	1. Gunakan fitur "Import" 2. Unggah file OpenAPI/Swagger 3. Petakan ke modul
Dari Permintaan	Menguji API yang sudah ada	1. Kirim permintaan terlebih dahulu 2. Klik "Save" 3. Sempurnakan spesifikasinya
Kloning yang Sudah Ada	Endpoint serupa	1. Klik kanan endpoint → "Duplicate" 2. Ubah path dan parameter

Menentukan Detail Endpoint

Informasi Dasar

Setiap endpoint memerlukan:

Nama: Judul deskriptif (misalnya, "Dapatkan Profil Pengguna")

Metode: Kata kerja HTTP

Path: Path URL dengan parameter

Deskripsi: Apa yang dilakukan endpoint

Parameter

Di workbench Apidog, Anda dapat mendefinisikan parameter yang menyesuaikan perilaku endpoint sebagai berikut (nilai hanya digunakan sebagai contoh):

Parameter Path

Digunakan dalam path URL itu sendiri:

GET /users/{userId}/posts/{postId}

Parameter	Tipe	Wajib	Deskripsi
`userId`	integer	Ya	Pengidentifikasi pengguna unik
`postId`	integer	Ya	Pengidentifikasi postingan

Parameter Query

Filter opsional dan paginasi:

Parameter	Tipe	Wajib	Default	Deskripsi
`limit`	integer	Tidak	10	Jumlah hasil yang akan dikembalikan
`offset`	integer	Tidak	0	Jumlah hasil yang akan dilewati
`status`	string	Tidak	active	Filter berdasarkan status

Body Permintaan (untuk POST/PUT)

Definisikan data input yang diharapkan menggunakan JSON Schema:

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "User's full name"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "User's email address"
    }
  },
  "required": ["name", "email"]
}

Respons

Definisikan semua kemungkinan format respons:

Respons Berhasil (200 OK)

{
  "id": 123,
  "name": "John Doe",
  "email": "john@example.com",
  "createdAt": "2023-01-15T10:30:00Z"
}

Respons Kesalahan

Kode Status	Deskripsi	Skema
`400`	Bad Request	Detail kesalahan
`401`	Unauthorized	Kesalahan autentikasi
`404`	Not Found	Sumber daya tidak ditemukan
`500`	Internal Server Error	Detail kesalahan server

Tab Design mencakup opsi spesifikasi API yang diperluas.

Langkah Berikutnya

Buat Permintaan

Membuat Endpoint

Apa itu Endpoint?#