Hei ada! Sebagai pembekal API (Bahan Farmaseutikal Aktif), saya sering bertanya tentang skema API. Jadi, saya fikir saya akan mengambil sedikit masa untuk memecahkannya untuk anda dengan cara yang mudah difahami.
Mari kita mulakan dengan asas -asas. Skema API adalah seperti pelan tindakan untuk API. Ini adalah penerangan terperinci tentang bagaimana API berfungsi, data yang diharapkan, dan data yang akan dikembalikan. Fikirkannya sebagai satu set peraturan dan garis panduan bahawa kedua -dua pembekal API (itu saya!) Dan pengguna API (itu anda atau pasukan anda) perlu mengikuti untuk memastikan komunikasi yang lancar dan cekap.
Mengapa skema API penting?
Nah, bayangkan anda sedang membina sebuah rumah. Anda tidak akan mula membuang batu bata tanpa rancangan, bukan? Begitu juga untuk API. Skema API menyediakan cara yang jelas dan konsisten untuk pemaju memahami dan menggunakan API. Ia membantu mengelakkan salah faham, mengurangkan peluang kesilapan, dan menjadikannya lebih mudah untuk mengintegrasikan API ke dalam aplikasi yang berbeza.
Contohnya, katakan anda pemaju yang ingin menggunakan API kami untuk mengakses maklumat mengenaiNano-karbon niobium, micron niobium carbide, niobium karbida ultra-halus, HFC. Skema API akan memberitahu anda dengan tepat apa titik akhir yang tersedia, parameter yang anda perlukan untuk lulus, dan format apa respons yang akan berlaku. Ini menjadikannya lebih mudah bagi anda untuk menulis kod untuk berinteraksi dengan API dan mendapatkan data yang anda perlukan.
Apa yang ada dalam skema API?
Skema API biasanya termasuk komponen berikut:
1
Ini adalah URL yang boleh anda panggil untuk mengakses fungsi API. Setiap titik akhir mewakili operasi tertentu, seperti mendapatkan senarai produk, membuat pesanan baru, atau mengemas kini maklumat pengguna.
2. Format permintaan dan tindak balas
Skema ini akan menentukan format data yang anda perlukan untuk menghantar permintaan anda (misalnya, JSON, XML) dan format data yang akan dikembalikan dalam responsnya. Ini memastikan bahawa kedua -dua pembekal API dan pengguna berada di halaman yang sama ketika datang ke pengendalian data.
3. Parameter
Ini adalah nilai -nilai yang boleh anda lalui ke titik akhir untuk menyesuaikan operasi. Sebagai contoh, anda mungkin lulus ID produk untuk mendapatkan maklumat mengenai produk tertentu, atau julat tarikh untuk menapis senarai pesanan.
4. Pengendalian ralat
Skema ini juga akan menggambarkan bagaimana API akan mengendalikan kesilapan. Ia akan menentukan kod ralat yang API mungkin kembali dan apa maksud setiap kod. Ini membantu pemaju memahami apa yang berlaku apabila ralat berlaku dan bagaimana untuk memperbaikinya.
Jenis skema API
Terdapat beberapa jenis skema API, masing -masing dengan kelebihan dan kes penggunaannya sendiri. Beberapa yang paling biasa termasuk:
Spesifikasi OpenAPI (OAS)
Ini adalah salah satu piawaian yang paling popular untuk mendokumentasikan API yang tenang. Ia menggunakan fail YAML atau JSON untuk menerangkan titik akhir API, permintaan dan format tindak balas, parameter, dan banyak lagi. OAS disokong secara meluas oleh alat dan kerangka, menjadikannya mudah untuk menghasilkan dokumentasi, SDK, dan kes ujian.
Skim GraphQL
GraphQL adalah bahasa pertanyaan untuk API yang membolehkan pelanggan meminta dengan tepat data yang mereka perlukan. Skema GraphQL mentakrifkan jenis data yang boleh dikembalikan API dan operasi yang boleh dilakukan pada jenis tersebut. Ia menyediakan cara yang lebih fleksibel dan cekap untuk mengakses data berbanding API tradisional yang tenang.
Buffer Protokol
Buffer Protokol (Protobuf) adalah format serialisasi binari bahasa-agnostik yang dibangunkan oleh Google. Ia menggunakan fail skema untuk menentukan struktur data yang akan bersiri dan deserialized. Protobuf dikenali dengan prestasi tinggi dan saiz mesej kecilnya, menjadikannya pilihan yang popular untuk API yang perlu mengendalikan sejumlah besar data.
Bagaimana Kami Menggunakan Skema API sebagai Pembekal API
Sebagai pembekal API, kami bergantung pada skema API untuk memastikan API kami mudah digunakan dan diintegrasikan. Kami menggunakan spesifikasi OpenAPI untuk mendokumenkan API kami, yang membolehkan kami menyediakan dokumentasi yang jelas dan terperinci untuk pelanggan kami. Dokumentasi ini merangkumi maklumat mengenai titik akhir, format permintaan dan tindak balas, parameter, dan pengendalian ralat.
Kami juga menggunakan skema API untuk mengesahkan permintaan yang kami terima daripada pelanggan kami. Dengan memeriksa permintaan masuk terhadap skema, kami dapat memastikan bahawa data berada dalam format yang betul dan semua parameter yang diperlukan hadir. Ini membantu mencegah kesilapan dan memastikan API kami boleh dipercayai dan selamat.
Di samping itu, kami menggunakan skema API untuk menjana kes SDK dan ujian. Dengan menggunakan alat yang menyokong spesifikasi OpenAPI, kami secara automatik dapat menghasilkan kod dalam bahasa pengaturcaraan yang berbeza, yang memudahkan para pelanggan kami untuk mengintegrasikan API kami ke dalam aplikasi mereka. Kami juga menggunakan skema untuk menghasilkan kes ujian, yang membantu kami memastikan API kami berfungsi dengan betul dan mereka memenuhi keperluan pelanggan kami.
Contoh dunia nyata
Mari kita lihat beberapa contoh dunia sebenar bagaimana skema API digunakan.
Contoh 1: Menggunakan API kami untuk mendapatkan maklumat mengenaiCAS THOOXANTHEN-9-ONE COTY: 492-22-8
Katakan anda seorang penyelidik yang ingin mendapatkan maklumat mengenai sebatian kimia tertentu. Anda boleh menggunakan API kami untuk mengakses data seperti sifat kompaun, kaedah sintesis, dan maklumat keselamatan. Skema API akan memberitahu anda dengan tepat apa titik akhir untuk dipanggil, parameter apa yang hendak diluluskan (contohnya, nombor CAS), dan apa format respons yang akan berlaku.
Berikut adalah contoh permintaan untuk API kami menggunakan curl:
Curl -x Dapatkan "https://api.oursite.com/compounds/492-22-8" -h "Terima: Permohonan/Json"Tanggapan mungkin kelihatan seperti ini:
{"name": "thioxanthen-9-one", "cas_number": "492-22-8", "molecular_weight": 212.26, "sifat": {"melting_point": "85-87 ° C", "boiling_point" ["Kaedah 1: React x dengan Y dengan kehadiran z ...", "Kaedah 2: Gunakan keadaan reaksi berikut ..."]}Contoh 2: Membuat pesanan baru untukCAS No.455943-61-0 Bekalan Besar
Sekiranya anda sebuah syarikat farmaseutikal yang ingin membuat pesanan untuk bekalan API tertentu, anda boleh menggunakan API kami untuk membuat pesanan baru. Skema API akan menentukan titik akhir untuk membuat pesanan, format permintaan (contohnya, butiran pesanan, kuantiti, dan alamat penghantaran), dan format tindak balas (misalnya, ID pesanan dan mesej pengesahan).
Berikut adalah contoh permintaan kepada API kami menggunakan Python:
Permintaan Import url = "https://api.oursite.com/orders" data = {"product_id": "4559943-61-0", "kuantiti": 1000, "Delivery_address": "123 Main St, anyTown, USA"} tajuk = tajuk) Cetak (response.json ())Tanggapan mungkin kelihatan seperti ini:
{"order_id": "123456", "Mesej": "Perintah yang dibuat dengan jayanya. Pesanan anda akan diproses dalam masa 24 jam." }Kesimpulan
Kesimpulannya, skema API adalah bahagian penting dari mana -mana API. Ia menyediakan cara yang jelas dan konsisten untuk pemaju memahami dan menggunakan API, mengurangkan peluang kesilapan, dan memudahkan untuk mengintegrasikan API ke dalam aplikasi yang berbeza. Sebagai pembekal API, kami bergantung pada skema API untuk memastikan API kami mudah digunakan, dipercayai, dan selamat.
Jika anda berminat menggunakan API kami untuk mengakses maklumat mengenai produk kami atau membuat pesanan, kami ingin mendengar daripada anda. Sama ada anda seorang penyelidik, syarikat farmaseutikal, atau pemaju, API kami dapat memberikan anda data dan fungsi yang anda perlukan. Oleh itu, jangan teragak -agak untuk menjangkau kami untuk membincangkan keperluan anda dan memulakan proses perolehan. Kami berada di sini untuk membantu anda memanfaatkan API kami dan memastikan pengalaman anda dengan kami adalah yang positif.
Rujukan
- Fielding, RT (2000). Gaya seni bina dan reka bentuk seni bina perisian berasaskan rangkaian. Universiti California, Irvine.
- Khare, R., & Frystyk, H. (1997). Protokol Pemindahan Hypertext - HTTP/1.1. RFC 2068.
- Lindley, S., & Miller, B. (2015). Graphql: Bahasa pertanyaan data. Facebook.
- Varda, A. (2008). Buffer Protokol: Format pertukaran data Google. Google Open Source Blog.
