Reka Bentuk Sumber API Resfful: Get/API/Tweets/1/Comments atau Get/API/Comments? Tweet_ID = 1, yang mana lebih sesuai dengan spesifikasi?

Sumber API Restful Nesting Amalan Terbaik: Reka Bentuk URL Untuk Komen Tweet

Pemprosesan hubungan sumber adalah penting apabila mereka bentuk API yang tenang. Sebagai contoh, dapatkan semua komen di bawah tweet tertentu, dan reka bentuk URL yang sesuai mencerminkan spesifikasi yang tenang. Artikel ini akan membandingkan dua skim reka bentuk URL dan menganalisis kebaikan dan keburukan mereka.

Katakan anda perlu mendapatkan semua komen tweet_id = 1 , skim satu adalah GET /api/tweets/1/comments , skim dua GET /api/comments?tweet_id=1 .

Penyelesaian 1: GET /api/tweets/1/comments

Skim ini bersarang mengulas sumber -sumber di bawah sumber tweet, dan URL secara langsung mencerminkan gabungan antara komen dan tweet. GET /api/tweets/1/comments dengan jelas menyatakan niat permintaan: Dapatkan semua komen untuk tweet dengan tweet_id 1. Ini mematuhi konsep bahawa laluan sumber mewakili hierarki sumber dalam prinsip yang tenang. Jika anda perlu mendapatkan komen tertentu (mis. comments_id = 1 ), gunakan GET /api/tweets/1/comments/1 .

Penyelesaian 2: GET /api/comments?tweet_id=1

Skim ini menggunakan parameter pertanyaan tweet_id untuk menentukan tweet, dan URL lebih seperti menanya sumber komen daripada mengakses sumber bersarang. Walaupun ia juga boleh mencapai tujuan, ia tidak langsung mencerminkan hubungan langsung antara komen dan tweet, dan ekspresi semantik URL agak lemah. Untuk mendapatkan komen dengan comments_id = 1 anda perlu menggunakan GET /api/comments/1 , yang berbeza daripada mendapatkan URL semua komen di bawah tweet tertentu, dan tidak mempunyai konsistensi.

Kesimpulan: Rancangan 1 lebih sesuai dengan spesifikasi yang tenang

Penyelesaian 1 ( GET /api/tweets/1/comments ) menang dengan keupayaan ekspresi sumber yang lebih jelas. Ia lebih intuitif menunjukkan gabungan antara sumber komen dan sumber tweet, dan mematuhi prinsip reka bentuk yang tenang. Sudah tentu, jika anda perlu mempertimbangkan toleransi kesalahan sumber komen yang dipadam, penyelesaian 2 mungkin lebih berfaedah, kerana sumber tweet yang relevan masih boleh didapati melalui tweet_id . Walau bagaimanapun, tanpa keperluan khas sedemikian, program satu mewakili amalan terbaik yang tenang. Menggunakan GET /api/comments/1 sahaja untuk mendapatkan komen khusus juga merupakan reka bentuk URL standard, tetapi ia tidak konsisten dengan skema satu dari segi struktur URL.

Atas ialah kandungan terperinci Reka Bentuk Sumber API Resfful: Get/API/Tweets/1/Comments atau Get/API/Comments? Tweet_ID = 1, yang mana lebih sesuai dengan spesifikasi?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!