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.

4
Layanan MVC dan RESTful API
MVC cukup mudah. Ada Model, Pengontrol dan Tampilan. Saat kami membuat situs web, semuanya datang bersamaan karena ' klien mengirimkan permintaan kata kunci REST ke server -> server mencocokkan URL yang diminta dengan tindakan pengontrol -> yang kemudian memanggil model untuk pengumpulan / pemrosesan data, dapatkan hasilnya -> dan mengembalikan …


3
Alasan di balik implementasi C # String.Split () yang tidak intuitif
Dalam C # jika saya ingin membagi stringdengan yang lain stringsaya harus melakukan sesuatu seperti itu: testString.Split(new string[] { "anotherString" }, StringSplitOptions.None); Dari String.SplitDokumentasi MSDN yang kelebihan beban kita bisa melihat implementasinya dan mengapa panggilan seperti itu harus dilakukan. Berasal dari Python , Sulit bagi saya untuk memahami dengan benar …

2
Peringatkan Arsitektur Sistem
Saya ingin membuat sistem yang menangani pesan-pesan peringatan dari berbagai program dan dapat memproses peringatan itu untuk konsumen yang tidak bersemangat melalui email. Ini semua akan terkandung dalam satu jaringan internal. Saya rasa saya ingin arsitektur dasar terlihat seperti ini: Perhatian utama yang saya miliki saat ini adalah bit "Message …


4
Sertakan tautan ke dokumentasi yang relevan dalam pesan kesalahan?
Kami membuat perpustakaan komersial dan contoh kode yang digunakan oleh pengembang eksternal. Kami memiliki (tertutup, tersedia untuk pengguna terdaftar) dokumentasi yang secara luas menjelaskan cara menggunakan perpustakaan. Banyak pengembang adalah pengguna pertama kali, sehingga banyak kesalahan mendasar yang ditemui. Apakah pantas memasukkan tautan ke dokumentasi di log kesalahan? Apa kemungkinan …

2
Mengapa pengecualian dicentang vs tidak dicentang disebut "kontroversi" di tutorial Oracle Java?
Saya baru di Jawa dan sedang membaca dokumentasinya tentang pengecualian. , dan khususnya Pengecualian yang Tidak Dicentang - Halaman Kontroversi . Intinya mengatakan: Jika klien secara wajar diharapkan pulih dari pengecualian, jadikan itu pengecualian terkecuali. Jika klien tidak dapat melakukan apa pun untuk memulihkan dari pengecualian, jadikan itu pengecualian yang …

2
Apakah 'Hukum Demeter' berlaku untuk tanda tangan metode publik / API?
Mengingat bahwa perubahan pada tanda tangan API / metode publik harus minimal untuk mencegah pemecahan kode klien yang menggunakan metode ini, saya bertanya-tanya apakah Hukum Demeter kurang berlaku untuk ini. Contoh sederhana: class Account() { double balance; public void debit(Transaction t) { balance -= t.getAmount(); } } Perhatikan bahwa metode …

5
Perangkap desain API di C [ditutup]
Ditutup . Pertanyaan ini didasarkan pada pendapat . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Ditutup 4 tahun yang lalu . Apa beberapa kelemahan yang membuat Anda gila di API C (termasuk perpustakaan standar, …
10 c  api-design  pitfalls 


2
Bagaimana cara menghindari penggunaan API yang tidak sah?
Saya harus merancang "widget", sebuah skrip yang akan dimasukkan oleh mitra di situs web mereka untuk menampilkan beberapa UI dan membuat panggilan ke API kami. Pada dasarnya itu akan menampilkan data kami di situs-situs ini berdasarkan pada beberapa ID yang mereka berikan dalam panggilan API kami. Yang ingin kami hindari …

3
Bagaimana saya merancang metode TryParse yang menyediakan informasi terperinci jika terjadi kesalahan penguraian?
Saat mem-parsing input pengguna, umumnya disarankan untuk tidak melempar dan menangkap pengecualian melainkan menggunakan metode validasi. Di .NET BCL, ini akan menjadi perbedaan antara, misalnya, int.Parse(melempar pengecualian pada data tidak valid) dan int.TryParse(mengembalikan falsedata tidak valid). Saya merancang sendiri Foo.TryParse(string s, out Foo result) metode dan saya tidak yakin tentang …
9 c#  .net  api-design 

3
Apakah praktik yang buruk untuk definisi objek API mengandung ID referensi pihak ketiga sebagai properti?
Seperti ini: Campaign: type: object properties: id: type: string description: "A GUID identifier" referenceId: type: string description: "A consumers identifier they have used to map their own systems logic to this object." name: type: string description: "'Great Campaign 2017' as an example" Saya prihatin dengan referenceId . Domain sistem adalah …

2
Menambah serangkaian opsi yang terbatas; perubahan API yang melanggar?
Ambil titik akhir HTTP API yang mengeluarkan model respons berikut: { "type": "Dog", "name": "Jessi", ... } The typelapangan telah dijelaskan dalam dokumentasi sebagai salah satu Dog, Catatau Fish. Apakah menambahkan opsi baru, katakanlah Rat, dianggap sebagai perubahan API yang melanggar? Apakah menambahkan opsi ke daftar terbatas (yang dapat diaktifkan …
9 rest  api  api-design  json 

3
Dalam bahasa REST, apa perbedaan antara sumber daya dan representasi?
Pemahaman saya tentang REST yang memungkinkan pemodelan operasi layanan sebagai representasi negara dan transisi dari satu negara ke negara lain menggunakan HTTP. Saya selalu memahami sumber daya sebagai representasi negara sisi layanan sampai baru-baru ini ketika saya membaca artikel ini oleh Jimmy Bogard yang saya tahu sebagai pengembang / arsitek …
9 rest  api  api-design 

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.