Apidoc: Permintaan sampel API mengirim params sebagai string kosong

Dibuat pada 23 Jan 2015 · 7Komentar · Sumber: apidoc/apidoc

Saat menggunakan sampleUrl untuk menghasilkan formulir guna menguji metode API, halaman apidoc mengirim semua parameter dari grup parameter yang saat ini dipilih ke titik akhir API, bahkan jika pengguna tidak mengisi nilai apa pun.

Misalnya, jika saya memiliki metode dengan 3 parameter, a , b dan c , semuanya opsional, dan saya hanya mengisi nilai ke a , setelah mengklik Send apidoc mengirimkan permintaan dengan nilai yang saya masukkan untuk a dan string kosong sebagai nilai untuk b dan c .

Ini tidak diinginkan dan merusak API yang tidak menerima string kosong sebagai nilai untuk parameter tersebut. Formulir sampel ini hanya boleh mengirim params yang disediakan secara khusus oleh pengguna.

todo

Sumber

tnunes

👍3

Komentar yang paling membantu

Saya telah membuat permintaan tarik untuk fitur ini di sini https://github.com/apidoc/apidoc/pull/647 , meskipun saya pribadi berpikir bahwa kita harus menyertakan semacam kotak centang di sebelah parameter opsional yang menunjukkan string kosong harus dikirim untuk permintaan sampel jika Anda benar-benar ingin mengirim string kosong.

tommybananas pada 19 Mei 2017

👍2

Semua 7 komentar

Saya mengirimkan PR # 193 yang diharapkan akan menangani masalah ini (params dan header juga).
Mungkin Anda bisa melihatnya, dan memberikan masukan Anda jika saya lupa sesuatu.

Terima kasih

Vincent

vherilier pada 23 Jan 2015

Saya tidak berpikir permintaan tarik Anda memperbaiki masalah ini, karena itu tidak mencegah pengiriman string kosong untuk params opsional.

Selain itu, tidak mungkin untuk memberikan nilai yang ditentukan pengguna untuk bidang yang diperlukan, karena Anda mengganti nilai ke default, jika ada, tanpa memverifikasi apakah yang digunakan memberikan nilai khusus.

Saya juga tidak berpikir apidoc harus mengirim nilai default untuk param apa pun. IMO, saat Anda mendokumentasikan param API dengan nilai default, Anda menjelaskan apa yang akan diasumsikan oleh panggilan API untuk nilai tersebut saat Anda tidak menyediakannya. Klien tidak boleh mengirim nilai itu, itu akan tersirat.

tnunes pada 23 Jan 2015

Maaf saya melewatkan sesuatu dalam masalah Anda, dan saya tidak memperbaiki masalah Anda. Itu benar, saya minta maaf...

vherilier pada 23 Jan 2015

Hai, apakah ada kemajuan dalam hal ini?, saya mencoba mendefinisikan permintaan PUT dan tidak ingin memperbarui bidang dengan string kosong, apakah ada cara untuk memberi tahu Apidoc agar hanya mengirim parameter yang diisi?