Dijual oleh Zinn Digital
Dokumentasi API yang diuji pembangun ditulis terus daripada kod anda, membolehkan jurutera baharu menyepadukan secara lancar tanpa memerlukan sokongan.
Di mana kebanyakan dokumentasi API tersilap langkah
Banyak panduan menyenaraikan titik akhir tetapi mengetepikan butiran yang sebenarnya menimbulkan kekeliruan: cara pengesahan berfungsi secara praktikal, contoh permintaan dan respons yang tepat, serta maksud ralat tertentu dan cara menyelesaikannya. Apabila ini berlaku, pembangun terpaksa menghantar tiket sokongan, yang menggagalkan tujuan mengadakan dokumentasi.
Pendekatan kami
Kami membina terus daripada kod sumber anda dan bukannya bergantung pada andaian. Kami memeriksa laluan, logik pengesahan dan pengendalian ralat anda, sebelum menguji API itu sendiri menggunakan kelayakan langsung. Setiap contoh dalam dokumentasi akhir mewakili permintaan tulen yang kami hantar dan respons yang kami terima, memastikan tiada butiran rekaan atau kod status yang mustahil.
Perkara yang anda terima
Format penyerahan
Kami membekalkan Markdown yang sesuai untuk repositori anda, berstruktur supaya ia memadankan OpenAPI atau tapak dokumentasi, mana-mana yang akan dipastikan sentiasa dikemas kini oleh pasukan anda. Sampel kod disediakan dalam bahasa yang digunakan oleh pengguna anda dan diuji dengan menjalankannya. Koleksi gaya Postman boleh disertakan atas permintaan.
Perkara yang kami perlukan daripada anda
Akses kepada repositori atau fail OpenAPI anda, kelayakan yang berfungsi untuk persekitaran ujian, dan soalan yang paling kerap dijawab oleh kakitangan sokongan anda - ini membentuk struktur panduan tersebut.
Perkara yang dikecualikan
Perkhidmatan ini merangkumi dokumentasi teknikal yang tepat tentang cara perisian beroperasi; teks promosi atau pemasaran ialah tugasan yang berasingan.
Proses dan masa
Anda akan menerima draf pertama yang lengkap, yang boleh anda semak terhadap soalan lazim yang dikendalikan oleh pasukan sokongan anda. Kami lebih suka jurutera menandakan kes luar biasa lebih awal daripada menyerahkan sesuatu yang kemas tetapi tidak tepat. Oleh kerana setiap contoh telah dijalankan terhadap API langsung anda, tiada apa-apa dalam dokumen akhir yang bersifat teori semata-mata.
Pakej ini merangkumi satu skop dokumentasi API harga tetap yang diserahkan dalam satu hantaran, dengan satu pusingan semakan, untuk 500.99 USD dan tempoh penyelesaian 10 hari. Anda perlu membekalkan domain yang berkaitan dengan pesanan tersebut serta taklimat anda.
USD 500.99
Atau bayar €447.16 · £374.43 pada kadar hari ini — kadar dikunci apabila anda menambahkannya ke bakul anda.
One fixed-price scope, delivered in one pass: API Documentation. - 1 revision
Dihantar dalam masa 10 hari
Semakan disertakan: 0
Tiada akaun diperlukan terlebih dahulu — akaun anda dibuat semasa pembayaran. Kami memegang wang tersebut sehingga anda menerima hasil kerja.
Ya - setiap permintaan yang dipaparkan dalam dokumentasi telah dijalankan pada persekitaran langsung, bermakna contoh-contoh tersebut menunjukkan gelagat sebenar perisian dan bukannya reka bentuk teori.
Kami terutamanya membekalkan Markdown di dalam repositori anda, walaupun kami juga boleh membekalkan spesifikasi OpenAPI dengan bahan rujukan yang disertakan. Kedua-dua pilihan memastikan penyelenggaraan yang mudah selepas penyerahan.
Ini disertakan sepenuhnya - meliputi penjanaan token, pembaharuan, senario tamat tempoh semasa sesi, dan punca utama di sebalik halangan penyepaduan biasa.