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.

6
Apakah ada pola untuk menangani parameter fungsi yang saling bertentangan?
Kami memiliki fungsi API yang memecah jumlah total menjadi jumlah bulanan berdasarkan tanggal mulai dan berakhir yang diberikan. // JavaScript function convertToMonths(timePeriod) { // ... returns the given time period converted to months } function getPaymentBreakdown(total, startDate, endDate) { const numMonths = convertToMonths(endDate - startDate); return { numMonths, monthlyPayment: total …
38 api-design 

3
REST API - Haruskah API Mengembalikan Objek JSON Bersarang?
Ketika datang ke API JSON apakah itu praktik yang baik untuk meratakan respons dan menghindari objek JSON bersarang? Sebagai contoh katakanlah kita memiliki API yang mirip dengan IMDb tetapi untuk video game. Ada beberapa entitas, Game, Platform, ESRBRating, dan GamePlatformMap yang memetakan Game dan Platform. Katakanlah Anda meminta / game …
38 design  rest  api-design  json 

5
Bagaimana cara menggambarkan perubahan arsitektur yang sengaja melanggar standar REST?
Saya mengusulkan perubahan pada proyek perangkat lunak yang dirancang dengan buruk yang mengalami banyak masalah. Pada tingkat tinggi, proyek ini menggunakan Angular di front-end dan menggunakan berbagai API REST; itu semua hebat (saya tidak melihat perlunya mengubah teknologi atau alat kami). Masalahnya adalah bahwa basis kode secara proporsional lebih besar …

6
Haruskah HTTP API selalu mengembalikan benda?
Apakah ada semacam standar terkait respons API HTTP? Setelah membaca utas wacana ini saya mulai bertanya-tanya. Kami sedang mengembangkan API HTTP JSON publik kami di tempat kerja saya, dan kami tidak mengembalikan apa pun ketika itu tidak sepenuhnya diperlukan (misalnya PUT ke / resource / {id} hanya mengembalikan 200 bila …
33 rest  api-design  http 


4
Haruskah Layanan Mikro berbicara satu sama lain?
Saya merancang aplikasi menggunakan Layanan Mikro dan saya tidak yakin tentang mekanisme terbaik yang digunakan untuk mengumpulkan data dari berbagai layanan. Saya percaya ada dua opsi: Mengintegrasikan mekanisme komunikasi 'antar-layanan' yang memungkinkan layanan untuk berbicara secara langsung. API Gateway akan memanggil layanan individual, yang kemudian memanggil layanan lain untuk mengumpulkan …



4
Layanan microser dan penyimpanan data
Saya sedang mempertimbangkan memindahkan REST API monolitik ke arsitektur layanan mikro, dan saya agak bingung tentang penyimpanan data. Seperti yang saya lihat, beberapa manfaat dari layanan microser adalah: Dapat diskalakan secara horizontal - Saya dapat menjalankan beberapa salinan berlebihan dari layanan microser untuk mengatasi beban dan / atau server turun. …


10
Desain API: pendekatan konkret vs abstrak - praktik terbaik?
Ketika membahas API antar sistem (pada tingkat bisnis) sering ada dua sudut pandang yang berbeda di tim kami: beberapa orang lebih suka pendekatan abstrak yang lebih umum - katakanlah generik , yang lain pendekatan "konkret" yang lurus ke depan. Contoh: desain API "pencarian orang" sederhana. versi konkretnya adalah searchPerson(String name, …

3
Apakah boleh mengembalikan HTML dari API JSON?
Pada proyek saya saat ini, saya bertanggung jawab untuk implementasi layanan yang melibatkan konsumsi API tenang yang baru dibuat, didokumentasikan sebagai semata-mata mendukung JSON. Klien secara konsisten membuat permintaan dengan tajuk terima 'aplikasi / json' dan tipe konten 'aplikasi / json'. Namun beberapa titik akhir mengirim respons dengan jenis konten …

4
Ketika membuat api haruskah saya menggunakan fungsi kecil dan banyak panggilan, atau beberapa panggilan dan fungsi besar?
Saya memiliki platform rel yang saya pelihara. Ini memiliki banyak aplikasi web berbeda yang dibangun di atasnya. Namun sekarang klien meminta API agar mereka dapat menjaga pengguna di situs mereka, tetapi manfaatkan beberapa tugas otomatis yang kami miliki. Platform ini digunakan untuk membuat aplikasi asuransi dan memungkinkan pembelian secara online, …


3
Kode status HTTP yang disarankan untuk respons "batas rencana terlampaui"
Saya merancang REST API untuk proyek di mana pengguna selalu menggunakan salah satu dari beberapa "paket" - setiap paket menentukan beberapa batasan sumber daya, seperti jumlah maksimal pengguna yang mungkin dimiliki akun atau jumlah maksimum data yang dapat mereka unggah. Setelah salah satu dari batasan ini tercapai, pengguna dapat meningkatkan …
24 rest  api-design  http 

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.