Pertanyaan yang diberi tag «api-design»

Desain Antarmuka Pemrograman Aplikasi (API) membahas praktik terbaik untuk membuat perpustakaan yang ditujukan untuk tujuan umum atau penggunaan umum.

14
Haruskah Anda menulis back-end Anda sebagai API?
Saya melakukan diskusi hangat hari ini tentang aplikasi MVC kami. Kami memiliki situs web yang ditulis dalam MVC ( ASP.NET ), dan biasanya mengikuti pola melakukan sesuatu dalam tampilan -> tekan controller -> controller membangun model (memanggil Manajer yang mendapatkan data, membangun model dalam metode controller itu sendiri) -> model …


7
Bagaimana cara pencarian masuk ke antarmuka RESTful?
Saat mendesain antarmuka RESTful, semantik dari tipe permintaan dianggap penting untuk desain. DAPATKAN - Daftar koleksi atau ambil elemen PUT - Ganti koleksi atau elemen POST - Buat koleksi atau elemen HAPUS - Ya, erm, hapus koleksi atau elemen Namun, ini sepertinya tidak mencakup konsep "pencarian". Misalnya dalam mendesain rangkaian …

14
Haruskah solusinya menjadi generik mungkin atau sespesifik mungkin?
Katakanlah saya memiliki entitas yang memiliki atribut "tipe". Mungkin ada 20+ tipe yang mungkin. Sekarang saya diminta untuk mengimplementasikan sesuatu yang memungkinkan perubahan tipe dari A-> B, yang merupakan satu-satunya use case. Jadi haruskah saya menerapkan sesuatu yang memungkinkan perubahan jenis sewenang-wenang asalkan mereka adalah tipe yang valid? Atau haruskah …

5
Haruskah saya mengembalikan status HTTP 400 (Permintaan Buruk) jika parameter secara sintaksis benar, tetapi melanggar aturan bisnis?
Katakanlah bahwa saya memiliki titik akhir REST yang menggunakan integer sebagai parameter: /makeWaffles?numberOfWaffles=3 Dalam hal ini, saya ingin angka menjadi positif karena saya tidak dapat membuat jumlah negatif wafel (dan meminta 0 wafel adalah buang-buang waktu). Jadi saya ingin menolak permintaan yang tidak mengandung bilangan bulat positif. Saya juga ingin …
56 api-design  http 

9
Haruskah Anda melindungi terhadap nilai yang tidak terduga dari API eksternal?
Katakanlah Anda mengode fungsi yang mengambil input dari API eksternal MyAPI. API eksternal itu MyAPImemiliki kontrak yang menyatakan akan mengembalikan a stringatau a number. Apakah disarankan untuk menjaga terhadap hal-hal seperti null, undefined, boolean, dll meskipun itu bukan bagian dari API dari MyAPI? Secara khusus, karena Anda tidak memiliki kendali …




3
Mengapa metode PATCH tidak idempoten?
Saya bertanya-tanya tentang ini. Misalkan saya memiliki usersumber daya iddan namebidang. Jika saya ingin memperbarui bidang, saya bisa melakukan permintaan PATCH ke sumber daya seperti ini PATCH /users/42 {"name": "john doe"} Dan kemudian aplikasi akan memperbarui nama pengguna 42. Tetapi mengapa jika saya mengulangi permintaan ini hasilnya akan berbeda? Menurut …

6
Seberapa perlunya mengikuti praktik pemrograman defensif untuk kode yang tidak akan pernah tersedia untuk umum?
Saya sedang menulis implementasi Java dari permainan kartu, jadi saya membuat tipe khusus Collection yang saya sebut Zone. Semua metode modifikasi Koleksi Java tidak didukung, tetapi ada metode di Zone API move(Zone, Card), yang memindahkan Kartu dari Zona yang diberikan ke dirinya sendiri (dilakukan dengan teknik paket-pribadi). Dengan cara ini, …

3
Apa yang sangat buruk tentang DOM?
Saya terus mendengar orang (khususnya Crockford) mengatakan DOM adalah API yang mengerikan, tetapi tidak benar-benar membenarkan pernyataan ini. Terlepas dari inkonsistensi lintas-browser, apa saja alasan mengapa DOM dianggap sangat buruk?

8
Mengapa java.util.ArrayList mengizinkan untuk menambahkan nol?
Saya bertanya-tanya mengapa java.util.ArrayListmemungkinkan untuk menambahkan null. Apakah ada kasus di mana saya ingin menambahkan nullke ArrayList? Saya mengajukan pertanyaan ini karena dalam sebuah proyek kami memiliki bug di mana beberapa kode ditambahkan nullke ArrayListdan sulit untuk menemukan di mana bug itu. Jelas sebuah NullPointerExceptiondilemparkan tetapi tidak sampai kode lain …


11
Haruskah REST API mengembalikan 500 Server Internal Kesalahan untuk menunjukkan bahwa permintaan referensi objek yang tidak ada?
Saya bekerja dengan REST API yang berada di server yang menangani data untuk banyak perangkat IoT. Tugas saya adalah meminta server menggunakan API untuk mengumpulkan informasi kinerja spesifik tentang perangkat tersebut. Dalam satu contoh, saya mendapatkan daftar perangkat yang tersedia dan pengidentifikasi yang sesuai, kemudian meminta server untuk detail lebih …

Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.