Bagaimana membuat API REST?

Hei ada! Sebagai pembekal API, saya tersentuh untuk berkongsi dengan anda bagaimana untuk membuat API REST. Rehat, yang bermaksud pemindahan negara perwakilan, adalah gaya seni bina yang digunakan secara meluas untuk membina perkhidmatan web. Ia sangat fleksibel, berskala, dan mudah difahami, menjadikannya pilihan utama bagi pemaju di seluruh dunia.

Memahami asas -asas rehat

Sebelum kita menyelam untuk mencipta API REST, mari kita cepat pergi ke atas apa rehat semua. REST adalah berdasarkan satu set prinsip yang menjadikan perkhidmatan web lebih cekap dan boleh dipercayai. Konsep utama termasuk sumber, yang merupakan data atau objek yang anda ingin dedahkan melalui API anda, dan kaedah HTTP seperti GET, POST, PUT, dan DELETE.

• Dapatkan: Digunakan untuk mendapatkan sumber. Sebagai contoh, jika anda mempunyai API untuk perpustakaan, permintaan GET boleh digunakan untuk mendapatkan senarai semua buku.
• Jawatan: Digunakan untuk mencipta sumber baru. Dalam contoh perpustakaan, permintaan pos boleh digunakan untuk menambah buku baru ke koleksi.
• Meletakkan: Digunakan untuk mengemas kini sumber yang sedia ada. Anda boleh menggunakan permintaan untuk mengemas kini butiran buku tertentu.
• Padam: Digunakan untuk mengeluarkan sumber. Jadi, jika anda ingin memadam buku dari perpustakaan, anda akan menggunakan permintaan padam.

Merancang API REST anda

Langkah pertama dalam membuat API REST merancang. Anda perlu memikirkan sumber apa yang anda ingin dedahkan dan bagaimana mereka akan dianjurkan. Fikirkan model data dan hubungan antara sumber yang berbeza. Sebagai contoh, jika anda membina API untuk kedai E - Commerce, anda mungkin mempunyai sumber seperti produk, pelanggan, dan pesanan.

Anda juga perlu membuat keputusan mengenai titik akhir API. Ini adalah URL yang akan digunakan oleh pelanggan untuk berinteraksi dengan API anda. Amalan yang baik adalah menggunakan kata nama untuk mewakili sumber di titik akhir anda. Contohnya,/produkboleh menjadi titik akhir untuk mendapatkan senarai semua produk, dan/produk/{product_id}boleh digunakan untuk mendapatkan butiran produk tertentu.

Menyiapkan persekitaran pembangunan

Sebaik sahaja anda merancang API anda, sudah tiba masanya untuk menubuhkan persekitaran pembangunan anda. Anda memerlukan bahasa pengaturcaraan dan rangka kerja. Pilihan popular untuk bangunan API rehat termasuk python dengan botol atau django, node.js dengan ekspres, dan java dengan boot musim bunga.

Katakan anda memilih Python dan Flask. Pertama, anda perlu memasang Python jika anda belum melakukannya. Kemudian, anda boleh memasang Flask menggunakanPIP Pasang Flask. Berikut adalah contoh mudah aplikasi flask yang membuat API REST asas:

Dari Flask Import Flask, jsonify app = flask (__ name__) @app.route ('/') def index (): kembali jsonify ({'message': 'selamat datang ke api kami!'}) jika __name__ == '__main__': app.run (debug = benar)

Dalam contoh ini, kami telah mencipta API mudah dengan titik akhir tunggal (/) yang mengembalikan respons JSON.

Melaksanakan titik akhir API

Sekarang persekitaran anda ditubuhkan, sudah tiba masanya untuk melaksanakan titik akhir API. Mari kita teruskan dengan contoh E - Commerce. Kami akan membuat titik akhir untuk mendapatkan senarai produk dan menambah produk baru.

Dari Flask Import Flask, jsonify, minta app = flask (__ name__) # Contoh data untuk produk produk = [{'id': 1, 'name': 'product 1', 'produre': 10.99}, {'id': 2, 'name': 'product 2', 'product': 19.99} @app.route (' jsonify (produk) @app.route ('/produk', kaedah = ['pos']) def add_product (): new_product = request.get_json () products.append (new_product) kembali jsonify (new_product), 201 jika __Name__ =

Dalam kod ini,/produkEndpoint dengan kaedah GET mengembalikan senarai semua produk, dan titik akhir yang sama dengan kaedah pos menambah produk baru ke senarai.

Mengendalikan kesilapan dan pengesahan

API rehat yang baik harus mengendalikan kesilapan dengan anggun dan mengesahkan input. Sebagai contoh, jika pelanggan menghantar permintaan tidak sah, API anda harus mengembalikan mesej ralat yang sesuai.

dari Flask Import Flask, jsonify, minta app = flask (__ name__) Products = [{'id': 1, 'name': 'Product 1', 'produre': 10.99}, {'id': 2, 'name' Product jsonify (produk) @app.route ('/produk', kaedah = ['pos']) def add_product (): new_product = request.get_json () jika tidak new_product atau 'nama' jsonify (new_product), 201 jika __name__ == '__main__': app.run (debug = true)

Di sini, kami telah menambah pengesahan keadd_productfungsi. Jika pelanggan tidak menghantar data produk yang sah, API mengembalikan ralat permintaan 400 buruk.

Mengamankan API REST anda

Keselamatan adalah penting ketika berehat API. Anda perlu melindungi API anda dari akses yang tidak dibenarkan. Salah satu cara biasa untuk melakukan ini adalah dengan menggunakan pengesahan dan kebenaran.

• Pengesahan: Ini mengesahkan identiti pelanggan. Anda boleh menggunakan kaedah seperti Kekunci API, OAuth, atau Token Web JSON (JWT). Sebagai contoh, jika anda menggunakan kekunci API, pelanggan perlu menghantar kunci API yang sah dalam tajuk permintaan untuk mengakses API.
• Kebenaran: Ini menentukan tindakan yang dibenarkan oleh pelanggan. Sebaik sahaja pelanggan disahkan, anda boleh menyemak sama ada mereka mempunyai keizinan yang diperlukan untuk mengakses sumber tertentu atau melakukan tindakan.

Menguji API REST anda

Sebelum anda menggunakan API anda, anda perlu mengujinya dengan teliti. Anda boleh menggunakan alat seperti Postman atau Curl untuk menghantar permintaan ke API anda dan periksa jawapannya.

Contohnya, untuk mengujiget_productsEndpoint menggunakan curl, anda boleh menjalankan arahan berikut:

Curl http://127.0.0.1:5000/products

Ini akan menghantar permintaan ke/produktitik akhir dan memaparkan respons.

Menggunakan API REST anda

Sebaik sahaja API anda diuji dan berfungsi dengan betul, sudah tiba masanya untuk menggunakannya. Anda boleh menggunakan platform awan seperti Heroku, AWS, atau Google Cloud. Platform ini memudahkan untuk menggunakan dan menguruskan API anda.

Persembahan API kami

Sebagai pembekal API, kami menawarkan pelbagai API untuk pelbagai industri. Contohnya, kami mempunyai APISerbuk Ambroxane 6790 - 58 - 5,Serbuk quinine hcl 60 - 93 - 5, danC12 - 20 Glukosida Alkil. API ini direka untuk menyediakan akses mudah kepada data dan fungsi yang berkaitan dengan produk ini, membantu anda menyelaraskan proses perniagaan anda.

Hubungi kami untuk perolehan

Jika anda berminat dengan API kami atau ingin membincangkan membuat API REST tersuai untuk keperluan khusus anda, jangan ragu untuk menjangkau. Kami di sini untuk membantu anda memanfaatkan teknologi API REST dan mengambil perniagaan anda ke peringkat seterusnya.

Rujukan

• Richardson, Leonard, dan Sam Ruby. Perkhidmatan web yang tenang. O'Reilly Media, 2007.
• Young, Mike. "Reka Bentuk API Web Restful." Corak & Amalan Microsoft, 2013.