Pembaca seperti Anda membantu mendukung MUO. Saat Anda melakukan pembelian menggunakan tautan di situs kami, kami dapat memperoleh komisi afiliasi. Baca selengkapnya.

Titik akhir API adalah titik koneksi antara dua program perangkat lunak. API memiliki titik akhir untuk setiap sumber daya. Titik akhir menentukan lokasi yang tepat dari sumber daya di server.

Ketika aplikasi klien meminta informasi dari server, itu melewati API. Yang kemudian mengakses permintaan dan memproses respons dari server. API kemudian mentransfer informasi yang diminta dari endpoint ke aplikasi.

API Anda efisien jika dapat berkomunikasi secara efektif melalui titik akhirnya. Itu memudahkan pengguna untuk mengakses sumber daya, meningkatkan pengalaman pengguna.

Bagaimana Cara Kerja Titik Akhir API?

Sistem terintegrasi berkomunikasi melalui API. Satu sistem mengirimkan permintaan ke API, menggunakan format seperti SOAP atau REST. Server menerima permintaan dan mentransfer respons kembali ke API. Lokasi sumber daya yang diminta itu adalah titik akhir.

instagram viewer

Sebelum titik akhir memproses permintaan, klien harus menyediakan URL, header, dan isi. Header berisi metadata tentang permintaan dan data detail tubuh yang dikirim ke server. Server juga dapat terhubung ke database itu metode API dapat mengakses.

Endpoint API biasanya bekerja dengan metode HTTP seperti GET, DELETE, PATCH, atau POST. Metode menentukan cara menggunakan titik akhir. Saat klien mengirimkan permintaan, ia perlu merumuskannya untuk menyertakan metode permintaan serta URL, misalnya:

MENDAPATKAN https://example.com/books/authors

Penamaan itu sulit, apakah itu titik akhir API, perangkat keras jaringan, atau fungsi dan variabel. Anda harus mempelajari beberapa praktik terbaik yang dapat Anda gunakan untuk memastikan titik akhir API Anda adalah sebuah aset.

1. Gunakan garis miring ke depan

Selalu gunakan garis miring ke depan untuk memisahkan sumber daya URI. Garis miring juga membantu menunjukkan hierarki sumber daya. Berikut ini adalah contohnya:

https://example.com/books/authors

2. Gunakan Kata Benda, Bukan Kata Kerja

Anda sebaiknya hanya menggunakan kata benda untuk memberi nama sumber daya. Kata benda menggambarkan untuk apa sumber daya itu sebagai lawan dari kata kerja yang menjelaskan apa yang dilakukan sumber daya. Berikut adalah contoh cara yang baik dan buruk untuk menamai titik akhir API.

Penamaan yang baik:

https://example.com/api/getBooks

Penamaan yang buruk:

http://example.com/api/books

3. Gunakan Kata Benda Jamak, Bukan Singular

Anda harus selalu menamai titik akhir API Anda dalam kata benda jamak. Ini menunjukkan kepada pengguna bahwa ada lebih dari satu sumber daya di server. Menggunakan kata benda tunggal dapat membingungkan pengguna sehingga berpikir hanya ada satu sumber daya.

Penamaan yang baik:

https://example.com/api/book/3

Penamaan yang buruk:

http://example.com/api/books/3

4. Gunakan Huruf Kecil

Anda harus mengetikkan semua URL dalam huruf kecil. Ini termasuk URL endpoint API. Ini contohnya:

Penamaan yang baik:

http://example.com/api/Books/3

Penamaan yang buruk:

http://example.com/api/books/3

5. Gunakan Tanda Hubung untuk Memisahkan Kata

Gunakan tanda hubung untuk memisahkan gabungan kata. Tanda hubung menghasilkan frasa yang lebih mudah dibaca daripada huruf besar atau garis bawah. Mereka juga lebih baik untuk tujuan SEO.

Penamaan yang baik:

https://example.com/api/books/33/front_cover

Penamaan yang buruk:

https://example.com/api/books/33/front-cover

6. Jangan Tambahkan Ekstensi File

Anda tidak perlu menambahkan ekstensi file ke titik akhir API Anda. Meskipun tidak memengaruhi keluaran, ekstensi mempersulit pembacaan sumber daya. Itu juga membuat sumber daya kurang fleksibel, merusaknya jika ekstensi berubah di masa mendatang.

Penamaan yang baik:

https://example.com/api/books.xml

Penamaan yang buruk:

https://example.com/api/books

7. Sertakan Versi

Anda harus selalu menamai titik akhir API Anda sesuai dengan versinya. Ini penting jika Anda membuat perubahan besar pada API. Ini membantu untuk membedakan antara dua atau lebih versi API dari mana sumber daya berasal. Anda dapat menunjukkan versi di awal titik akhir.

Misalnya:

https://example.com/api/v3/books

Mengapa Mempertimbangkan Praktik Terbaik API?

API telah menjadi tulang punggung pemrograman modern. Mereka meningkatkan kolaborasi, mendorong inovasi, dan meningkatkan keamanan aplikasi.

Apakah menggunakan alat baru atau mengelola yang sudah ada, API menyederhanakan prosesnya. Jadi, penting untuk memiliki titik akhir yang meningkatkan pengalaman pengguna. Penamaan dan struktur titik akhir API Anda menentukan kinerja API Anda.

Pastikan Anda menggunakan praktik terbaik untuk membuat titik akhir API yang efisien.