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
Apa kesamaan API yang hebat? [Tutup]
Ditutup . Pertanyaan ini perlu lebih fokus . Saat ini tidak menerima jawaban. Ditutup 6 tahun yang lalu . Terkunci . Pertanyaan ini dan jawabannya dikunci karena pertanyaannya di luar topik tetapi memiliki makna historis. Saat ini tidak menerima jawaban atau interaksi baru. Ada apa dengan API hebat yang membuatnya …
15 api-design 

7
Bagaimana cara merancang otentikasi pengguna dari aplikasi klien?
Saya telah mengembangkan aplikasi yang akan mendukung banyak pengguna. Masalahnya adalah saya tidak bisa mencari tahu, bagaimana cara mengotentikasi klien / pengguna. Saya membuat aplikasi seperti http://quickblox.com/ di mana saya akan memberikan kredensial kepada pengguna saya dan mereka akan menggunakannya untuk membangun aplikasi N di mana mereka tidak dapat memasukkan …

1
Apa cara yang tepat untuk bersarang sumber daya dalam model REST?
Saya merancang API layanan REST dan macet di jalan yang tepat ke sumber daya sarang. Sumber daya: mitra, tiket, pengaturan Koneksi antara sumber daya: mitra memiliki banyak tiket, mitra memiliki set pengaturan, Logika bisnis: Anda dapat mencantumkan semua mitra sebagai pengguna anonim, Anda dapat menambahkan tiket baru ke mitra yang …
14 api  rest  api-design 

5
Dalam desain API, kapan harus menggunakan / menghindari polimorfisme ad hoc?
Sue sedang merancang perpustakaan JavaScript Magician.js,. Kunci pasnya adalah fungsi yang menarik Rabbitkeluar dari argumen yang disahkan. Dia tahu penggunanya mungkin ingin menarik kelinci keluar dari String, a Number, a Function, bahkan mungkin a HTMLElement. Dengan pemikiran itu, ia dapat merancang API-nya seperti: Antarmuka yang ketat Magician.pullRabbitOutOfString = function(str) //... …

3
Haruskah ID backend bersifat publik atau tidak pada REST API?
Berdasarkan apa yang dikatakan orang ini: http://toddfredrich.com/ids-in-rest-api.html Anggaplah dia benar tentang menggunakan UUID untuk mengidentifikasi sumber api. Lalu saya mengalami kesulitan mencoba menerapkannya seperti ini, ini adalah: class FooEntity { final String id = null; //auto-generated by my backend (mongodb), not shared final UUID uid = UUID.randomUUID(); //the resource id …

4
Gunakan komposisi dan warisan untuk DTO
Kami memiliki ASP.NET Web API yang menyediakan REST API untuk Aplikasi Satu Halaman kami. Kami menggunakan DTO / POCO untuk meneruskan data melalui API ini. Masalahnya sekarang, bahwa DTO ini semakin besar dari waktu ke waktu, jadi sekarang kami ingin memperbaiki DTO. Saya mencari "praktik terbaik" bagaimana merancang DTO: Saat …
13 rest  api-design  web-api  dto  poco 

1
Kapan saya harus menggunakan AtomPub?
Saya telah melakukan beberapa penelitian ke dalam desain layanan web RESTful dan saya telah mencapai apa yang saya pikir adalah titik keputusan utama jadi saya pikir saya akan menawarkannya kepada masyarakat untuk mendapatkan beberapa saran. Sesuai dengan prinsip-prinsip arsitektur RESTful saya ingin menyajikan API yang dapat ditemukan, jadi saya akan …

8
Apakah antarmuka yang menampilkan fungsi async adalah abstraksi yang bocor?
Saya membaca buku Prinsip Ketergantungan Injeksi, Praktek, dan Pola dan saya membaca tentang konsep abstraksi bocor yang dijelaskan dengan baik dalam buku ini. Hari ini saya refactoring basis kode C # menggunakan injeksi dependensi sehingga panggilan async digunakan alih-alih memblokir yang. Melakukannya saya sedang mempertimbangkan beberapa antarmuka yang mewakili abstraksi …

3
Flat atau bersarang JSON untuk data hierarki?
Saya sudah bolak-balik ~ 5 kali sudah. Titik akhir REST ini /api/tags/akan untuk penggunaan internal (tidak ada klien pihak ke-3), saya satu-satunya yang bekerja dengannya. Saya memutuskan antara dua representasi ini: Datar { "types":[ { "id":1, "text":"Utility" }, { "id":7, "text":"Lease Terms" }, ], "tags":[ { "id":8, "text":"Water", "type":1 }, …
12 rest  api-design  json 

2
Haruskah saya mengizinkan parameter yang tidak diketahui?
Saya merancang API yang tenang dan dihadapkan dengan masalah judul, disajikan kembali untuk kejelasan: Haruskah saya gagal dengan cepat jika klien mengirim parameter yang tidak dikenal? Sebagai contoh, http://example.com/api/foo?bar=true&paula=bean Di atas, baradalah parameter yang valid tetapi paulatidak ditentukan oleh API. Haruskah saya Peringatkan klien kesalahan Gagal cepat Abaikan itu Jika …
12 rest  api-design 

1
Pertahankan API vs. menggunakan idiom di port
Saya sedang mengerjakan port dari Python ke Rust dan berlari ke beberapa kode yang tidak bisa diekspresikan secara alami di Rust seperti yang mereka bisa di Python. Salah satu kasusnya adalah menggunakan parameter default: class Foo: def __init__(self, a="Hello"): self._a = a Di Rust, Anda dapat menerapkan ini menggunakan pembangun: …

2
Menerapkan pola perintah di API RESTful
Saya sedang dalam proses mendesain API HTTP, semoga membuatnya setenang mungkin. Ada beberapa tindakan yang fungsionalitasnya tersebar di beberapa sumber daya, dan terkadang perlu dibatalkan. Saya berpikir sendiri, ini terdengar seperti pola perintah, tetapi bagaimana saya bisa memodelkannya menjadi sumber daya? Saya akan memperkenalkan sumber daya baru bernama XXAction, seperti …

2
C ++ Library API Design
Saya sedang mencari sumber yang bagus untuk belajar tentang desain API yang baik untuk pustaka C ++, melihat objek bersama / dll. Ada banyak sumber daya untuk menulis API yang bagus, kelas yang bagus, templat dan sebagainya di tingkat sumber, tetapi hampir tidak ada apa-apa tentang menempatkan hal-hal bersama dalam …

2
Bagaimana merancang titik akhir API untuk memposting objek anak dan untuk mendapatkan semua anak dari semua orang tua?
Misalnya saya punya entitas: Klien, Laporan. Klien mungkin memiliki banyak Laporan dan saya pikir titik akhir untuk satu manajemen Laporan harus disarangkan seperti ini: /clients/{client_id}/reports/{report_id} Adapun semua laporan dari satu klien titik diharapkan: /clients/{client_id}/reports Tetapi bagaimana seharusnya terlihat titik akhir untuk mendapatkan semua Laporan dari semua Klien agar API konsisten …
12 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.