Bangunan dan Ujian API lebih mudah dengan Postman

Postman: Alat yang berkuasa untuk memudahkan pembangunan dan ujian API

Mata utama:

• Postman adalah alat yang berkuasa yang memudahkan proses pembangunan dan ujian API, menyediakan fungsi seperti menyelamatkan panggilan API yang lalu dan panggilan API yang berkaitan dengan kumpulan, yang mudah dan pantas.
• API (Antara Muka Pengaturcaraan Aplikasi) biasanya dibuat menggunakan rangka kerja yang lain (Denotative State Transfer), yang menetapkan garis panduan untuk API berasaskan web. Empat operasi yang paling biasa dilakukan melalui API adalah melihat, membuat, mengedit, dan memadam objek.
• Ujian API adalah bahagian penting dalam proses pembangunan untuk memastikan fungsi, pengendalian pengecualian dan keselamatan. Ini boleh dilakukan dengan menggunakan baris perintah perpustakaan curl, tetapi alat seperti Postman boleh membuat proses ini lebih mudah.
• Postman boleh digunakan untuk menghantar permintaan kepada API seperti Facebook Graph API, yang membolehkan pemaju melihat jawatan, seperti jawatan, membuat jawatan, dan memadam jawatan. Alat ini boleh menjadi aset yang berharga bagi pemaju menggunakan API.

Terima kasih kepada Jeff Smith atas bantuannya, dia bersemangat untuk mengambil bahagian dalam kajian rakan sebaya artikel ini.

---

artikel popular di laman web SitePoint hari ini:

• Apa itu http/2?
• Gunakan tiga kaedah CSS ini untuk menjinakkan lembaran gaya yang tidak terkawal
• senarai penyelenggaraan WordPress biasa anda
• hosting pelayan dikongsi: Pro and Cons
• Kenapa setiap laman web memerlukan https

---

API (antara muka pengaturcaraan aplikasi) adalah medium untuk interaksi antara aplikasi. API yang menggunakan HTTP atau HTTPS dipanggil API Web.

Jika anda melihat sekitar internet, anda akan mendapati bahawa sebilangan besar perkhidmatan menggunakan API. Mana-mana perkhidmatan dengan Login Sosial menggunakan API;

Dengan membuat API untuk perkhidmatan anda, anda boleh membolehkan pemaju pihak ketiga untuk membuat aplikasi berdasarkan perkhidmatan anda. Sebagai contoh, laman berita sosial Frrole menggunakan API Twitter untuk menghasilkan pandangan kontekstual dengan menganalisis sejumlah besar tweet.

Dengan mengandaikan anda telah menilai kebaikan dan keburukan untuk mewujudkan API, mari kita membincangkan proses membuat dan menguji API secara ringkas.

Buat API

Walaupun terdapat banyak cara untuk membuat API, API Web dicipta menggunakan rangka kerja yang lain (Denotative State Transfer). Rangka lain menentukan satu set garis panduan yang mesti diikuti ketika membuat API. Oleh kerana banyak API yang dibuat setiap hari, ia menjadi standard untuk API berasaskan web.

Empat operasi yang paling biasa dilakukan melalui API sedang melihat, mencipta, mengedit, dan memadam objek. Rangka kerja lain memaparkan empat kata kerja HTTP untuk operasi ini: Dapatkan, pos, letakkan, dan padam. Banyak kata kerja ditambah ke senarai ini, seperti Purge dan Patch, tetapi dalam artikel ini kita hanya akan membincangkan empat kata kerja asas. Satu artikel mengenai amalan terbaik API Restful Pragmatic yang ditulis oleh pengasas Enchant.com Vinay Sahni mungkin berguna untuk pemaju kali pertama.

Ramai kerangka hari ini menyediakan pembalut untuk lapisan HTTP asas, menjadikan pembangunan anda lebih mudah. Anda hanya perlu memanggil arahan atau fungsi yang diperlukan dan fokus pada fungsi. Contoh-contoh popular termasuk Slim dan Toro, dua rangka miniatur berasaskan PHP yang dapat membantu anda membuat API REST dengan cepat.

ujian API melalui CLI

Tujuan utama untuk mewujudkan API adalah untuk membolehkan aplikasi lain (mungkin anda sendiri atau dibangunkan oleh pihak ketiga) untuk menggunakan perkhidmatan ini. Oleh itu, pada setiap peringkat proses pembangunan API, langkah penting adalah untuk menguji fungsi API, pengendalian pengecualian, dan keselamatan.

menggunakan API melibatkan membuat permintaan kepada sumber yang dikehendaki (biasanya URL) menggunakan salah satu kata kerja (atau kaedah). Bergantung kepada keperluan API yang anda gunakan, anda mungkin perlu menambah tajuk. Salah satu cara untuk meminta sumber -sumber tersebut adalah melalui baris arahan.

Dalam artikel ini, kita akan memberi tumpuan kepada empat bahagian panggilan API -URL, kata kerja HTTP, header, dan parameter. Kami akan menggunakan Perpustakaan Curl untuk menghantar permintaan kepada sumber API melalui CLI. Curl adalah alat baris arahan yang membantu memindahkan data menggunakan sintaks URL - menyokong FTP, FTP, HTTP, HTTPS.

mari kita lihat perintah berikut:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

Perintah

-i bermaksud termasuk, yang memberitahu perintah bahawa tajuk ada dalam permintaan. Pilihan -x mengikuti kata kerja atau kaedah HTTP dengan segera. -H Menentukan tajuk tersuai yang ditambahkan pada permintaan. Akhirnya, pilihan -D menentukan data borang tersuai yang akan diluluskan dengan permintaan.

Hasil panggilan API

adalah respons HTTP, biasanya dikodkan dalam format JSON. Tanggapan disediakan dengan kod respons HTTP yang memberikan maklumat mengenai status permintaan (misalnya, 200 bermakna OK, 404 bermaksud sumber tidak wujud, 500 bermaksud ralat pelayan, dan 403 bermaksud sumbernya dilarang). Sebagai contoh, tindak balas berikut boleh dihantar sebagai hasil dari permintaan sebelumnya, serta 200 kod status:

<code>{"message":"success","id":"4"}</code>

Menguji tindak balas sedemikian dalam baris arahan juga menimbulkan cabaran, terutamanya jika respons mempunyai sejumlah besar pilihan.

Panduan terperinci ini dari CodingPedia menyenaraikan senarai pilihan CLI semasa menguji API.

memudahkan ujian dengan Postman

Postman adalah kit pembangunan API yang kuat yang menjadikan proses pembangunan API cepat dan mudah. Ia boleh digunakan sebagai lanjutan krom dan aplikasi asli untuk Mac, Windows dan Linux. Lebih daripada satu juta pemaju telah mencubanya. Untuk memasang sambungan Chrome, anda perlu memasang Chrome terlebih dahulu dan kemudian pergi ke halaman projek kedai web Chrome.

mari kita mula -mula memahami bagaimana untuk mensimulasikan permintaan CLI sebelumnya melalui Postman. Imej berikut menunjukkan membuat panggilan API di Postman dengan semua empat bahagian yang dibincangkan di atas:

Selain pratonton (jika respons adalah HTML), respons yang anda terima melalui permintaan juga boleh dilihat dalam bentuk asal atau indah. Imej berikut menunjukkan cara yang berbeza untuk melihat respons di Postman:

Postman secara automatik menjimatkan panggilan API yang anda buat pada masa lalu, yang dapat menjimatkan masa ketika menguji API. Di samping itu, mereka boleh dikelompokkan ke dalam panggilan API yang berkaitan untuk kemudahan anda. Berikut adalah contoh sejarah panggilan API melalui Postman:

Menggunakan API Grafik Facebook melalui Postman

Cara yang baik untuk menunjukkan bagaimana kerja postman melalui API Graf Facebook. Dalam siaran ini, kami akan memberi tumpuan kepada jawatan pada garis masa pengguna, bagaimana untuk melihat butiran jawatan, dan bagaimana untuk membuat dan memadam jawatan.

Token akses adalah penting apabila menggunakan API Grafik. Tanda dikaitkan dengan banyak kebenaran. Sebagai contoh, anda boleh membuat jawatan menggunakan token hanya jika Publish_Actions adalah salah satu medan yang dipilih apabila menghasilkan token. Tahap keselamatan tambahan ini dapat membantu anda memberikan tindakan khusus kepada aplikasi tertentu ketika log masuk melalui Facebook.

Lihat Posts

Untuk menghantar permintaan ke API graf, anda perlu menghasilkan token akses. Setelah menjana token, anda harus menghantar permintaan GET ke URL berikut dan menggunakan Access_Token sebagai parameter:

Imej berikut menunjukkan panggilan API graf asas dengan butiran anda:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

anda boleh menyemak senarai siaran pada garis masa anda dengan mengikuti arahan:

Berikut adalah bagaimana butiran senarai pos pada garis masa anda mungkin muncul:

<code>{"message":"success","id":"4"}</code>

Untuk melihat butir -butir jawatan tunggal, gunakan sumber -sumber berikut:

Butiran satu jawatan adalah seperti berikut:

<code>GET /me/</code>

seperti

suka, hantarkan permintaan pos ke url berikut (sila ambil perhatian bahawa suka memerlukan penerbitan_aksi):

Kirim permintaan seperti melalui Postman seperti berikut:

<code>GET /me/feed/</code>

Begitu juga, anda boleh memadamkan sebagainya dengan menghantar permintaan padam ke url yang sama:

Buat jawatan

Untuk membuat siaran, anda perlu menghantar beberapa parameter sebagai tambahan kepada permintaan pos. Anda juga memerlukan Publish_Actions untuk melakukan ini.

anda boleh menambah pilihan berikut untuk permintaan pos anda:

<code>GET /post-id/</code>

• Mesej: Mesej yang dikaitkan dengan siaran
• pautan: Pautan ke sumber luaran
• tempat: lokasi yang berkaitan dengan jawatan (serupa dengan "daftar masuk" lokasi)
• tags: mana -mana rakan atau halaman
• Privasi: Penonton untuk jawatan dapat dilihat
• Object_Attachment: Mana -mana catatan Facebook yang ada

Dokumentasi menerangkan bagaimana semua fungsi ini digunakan.

anda boleh membuat siaran pada garis masa anda sendiri atau pada garis masa pengguna, halaman, acara atau kumpulan berdasarkan URL yang anda pilih untuk menghantar permintaan:

<code>curl -i -X POST -H 
    "Content-Type:application/json" 
    http://www.my-api-example.com:port/ -d 
    '{"Name":"Something"}'</code>

Mari cuba hantar ke garis masa kita sendiri. Sekiranya permintaan itu berjaya, kami akan mendapat ID jawatan yang dibuat. Berikut adalah contoh membuat jawatan baru menggunakan API Graf:

Untuk mengedit siaran, anda perlu menghantar permintaan pos (tidak diletakkan) ke URL berikut dan gunakan parameter yang sama seperti yang anda lakukan apabila anda membuat siaran:

<code>{"message":"success","id":"4"}</code>

Padam jawatan

Sama seperti memadam seperti, memadam jawatan memerlukan anda menghantar permintaan padam ke URL pos:

<code>GET /me/</code>

Nota: Kami telah melihat dalam artikel ini bahawa Postman mempunyai banyak ciri berguna. Selepas menaik taraf versi percuma ($ 9.99 setiap lesen), terdapat lebih banyak ciri - seperti koleksi API yang menjalankan pada pelbagai nilai data.

Kesimpulan

Mewujudkan API adalah tugas penting, yang melibatkan banyak langkah penting. Postman membuat proses ujian menyeluruh lebih mudah. Pada masa ini, Postman seolah -olah menyelesaikan masalah pemaju purata dengan baik. Walau bagaimanapun, bagaimana ia berubah dengan peralihan paradigma yang biasa dijumpai dalam industri web masih dapat dilihat.

Adakah kita kehilangan ciri -ciri penting Postman? Adakah anda menggunakan pelanggan lain untuk menguji API? Tolong beritahu kami dalam komen di bawah.

soalan yang sering ditanya mengenai bangunan dan ujian API dengan Postman

Apa itu Postman dan bagaimana ia membantu membina dan menguji API?

Postman adalah alat yang popular untuk pemaju untuk membina dan menguji API. Ia menyediakan antara muka mesra pengguna yang membolehkan permintaan HTTP yang mudah dan tontonan yang mudah. Postman menyokong pelbagai jenis permintaan HTTP, seperti Get, Post, Delete, Put, dll. Ia juga membolehkan anda menyimpan permintaan dan menyusunnya ke dalam koleksi untuk akses mudah dan perkongsian. Ciri-ciri ujian terbina dalam Postman membolehkan anda menulis ujian untuk API anda secara langsung dalam alat itu sendiri, menjadikannya penyelesaian yang komprehensif untuk pembangunan API.

Adakah postman percuma untuk digunakan?

Postman menawarkan versi percuma dan berbayar. Versi percuma, yang dipanggil Postman Basic, menawarkan satu set ciri yang cukup untuk memenuhi keperluan pemaju individu atau pasukan kecil. Postman menawarkan pelan berbayar untuk pasukan besar atau perniagaan yang memerlukan ciri -ciri dan kerjasama canggih.

Bagaimana Postman Pro berbeza dari versi asas?

Postman Pro adalah versi berbayar yang menawarkan ciri tambahan yang tidak dijumpai dalam versi asas. Ini termasuk kerjasama pasukan, pemantauan API, dokumentasi API lanjutan, dan banyak lagi. Ia direka untuk pemaju profesional dan pasukan yang perlu menguruskan projek pembangunan API yang kompleks.

bagaimana untuk membeli posman?

Anda boleh membeli Postman dari laman web rasmi mereka. Mereka menawarkan rancangan harga yang berbeza berdasarkan saiz pasukan anda dan keperluan khusus. Anda boleh memilih pelan yang sesuai dengan keperluan anda dan mengikuti arahan untuk menyelesaikan pembelian.

Apakah peranan Postman dalam Pembangunan Perisian?

Dalam pembangunan perisian, Postman memainkan peranan penting dalam pembangunan dan ujian API. Ia membolehkan pemaju membina, menguji dan mendokumenkan API pada satu platform, dengan itu memudahkan proses pembangunan. Ia juga menyokong kerjasama, menjadikannya lebih mudah bagi pasukan untuk bekerja di projek API bersama -sama.

Bolehkah saya menggunakan Postman untuk ujian automatik?

Ya, Postman menyokong ujian automatik. Anda boleh menulis ujian untuk API anda di Postman dan menjalankannya secara automatik menggunakan Runner Collection Postman atau Newman (Alat Perintah Postman). Ini menjadikannya lebih mudah untuk mengintegrasikan ujian API ke dalam saluran integrasi berterusan/berterusan penghantaran (CI/CD).

Bagaimana untuk mengatur permintaan API saya di Postman?

Postman membolehkan anda mengatur permintaan API ke dalam koleksi. Koleksi adalah satu set permintaan yang berkaitan yang boleh disimpan bersama. Ini menjadikannya lebih mudah untuk mengurus dan berkongsi permintaan anda. Anda juga boleh menambah folder ke koleksi untuk organisasi selanjutnya.

Adakah Postman menyokong pelbagai jenis pengesahan?

Ya, Postman menyokong pelbagai jenis pengesahan, termasuk asas auth, token pembawa, OAuth 1.0, OAuth 2.0, dan banyak lagi. Ini menjadikannya alat yang serba boleh untuk menguji API dengan keperluan pengesahan yang berbeza.

Bolehkah saya berkongsi koleksi postman saya dengan orang lain?

Ya, Postman membolehkan anda berkongsi koleksi anda dengan orang lain. Ini amat berguna untuk kerja berpasukan. Jika anda menggunakan versi berbayar, anda boleh berkongsi koleksi dengan mengeksportnya sebagai fail JSON atau berkongsi terus dari Postman.

Bagaimana untuk belajar menggunakan Postman dengan berkesan?

Terdapat banyak sumber untuk belajar posman. Laman web Postman rasmi menyediakan dokumentasi dan tutorial yang komprehensif. Terdapat juga banyak kursus dalam talian, blog dan forum di mana anda boleh mempelajari pengalaman pengguna postman yang lain.

Atas ialah kandungan terperinci Bangunan dan Ujian API lebih mudah dengan Postman. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!