cari
Rumahpembangunan bahagian belakangTutorial PythonCara membina API yang berkuasa menggunakan Flask-RESTPlus

Cara membina API yang berkuasa menggunakan Flask-RESTPlus

Aug 02, 2023 am 10:25 AM
flask-restplus: lanjutan rangka kerja flaskdigunakan untuk membina api

Cara membina API yang berkuasa menggunakan Flask-RESTPlus

Petikan:
Dalam pembangunan web, membina API (Antaramuka Pengaturcaraan Aplikasi) adalah sangat biasa dan penting. API ialah satu cara untuk membenarkan interaksi antara aplikasi yang berbeza, dan ia mentakrifkan spesifikasi untuk cara meminta dan bertindak balas kepada data. Flask-RESTPlus ialah perpustakaan sambungan berasaskan Flask yang memudahkan proses membina dan mendokumentasikan API yang berkuasa. Artikel ini akan memperkenalkan cara menggunakan Flask-RESTPlus untuk membina API yang berkuasa dan menyediakan beberapa contoh kod untuk rujukan.

1. Pasang dan sediakan Flask-RESTPlus
Sebelum kita mula, kita perlu memasang Flask dan Flask-RESTPlus dalam persekitaran Python. Mereka boleh dipasang menggunakan arahan pip:

pip install flask restplus

Selepas pemasangan selesai, kita boleh mula membina API.

2. Mulakan aplikasi Flask
Pertama, kita perlu mencipta aplikasi Flask baharu dan mengimport sambungan Flask-RESTPlus. Dalam aplikasi, kami juga perlu mencipta ruang nama API (Namespace) untuk mengatur dan mengurus titik akhir API yang berbeza.

from flask import Flask
from flask_restplus import Api, Resource

app = Flask(__name__)
api = Api(app)

3 Tentukan laluan dan sumber
Dalam Flask-RESTPlus, sumber ialah bahagian penting API dan ia sepadan dengan titik akhir API yang berbeza. Kita boleh menggunakan penghias @api.route untuk menentukan laluan dan sumber. @api.route装饰器来定义路由和资源。

@api.route('/example')
class ExampleResource(Resource):
    def get(self):
        return {'message': 'Hello, World!'}

在上面的示例中,我们定义了一个名为'/example'的路由,并将其与ExampleResource类绑定。该类包含了一个get()方法,用于处理GET请求。在此示例中,我们只是返回了一个简单的JSON响应。

四、请求和响应模型
为了确保API的安全性和一致性,我们通常需要定义请求和响应的数据模型。Flask-RESTPlus提供了一个Model对象来定义模型,并提供了一些常见的字段类型,如String、Integer、Boolean等。

from flask_restplus import fields

example_model = api.model('ExampleModel', {
    'id': fields.Integer(required=True, description='The example ID'),
    'name': fields.String(required=True, description='The example name')
})

在上面的示例中,我们定义了一个名为ExampleModel的模型,它有两个字段:id和name。这些字段都是必填项。

五、请求和响应数据验证
根据模型定义,Flask-RESTPlus可以自动验证请求和响应的数据。我们可以使用@api.expect装饰器来指定请求的数据模型,并使用@api.marshal_with

@api.route('/example')
class ExampleResource(Resource):
    @api.expect(example_model, validate=True)
    @api.marshal_with(example_model)
    def post(self):
        return api.payload

Dalam contoh di atas, kami menentukan laluan bernama '/example' dan mengikatnya dengan kelas ExampleResource. Kelas ini mengandungi kaedah get() untuk mengendalikan permintaan GET. Dalam contoh ini, kami baru sahaja mengembalikan respons JSON yang mudah.

4 Model permintaan dan respons

Untuk memastikan keselamatan dan konsistensi API, kami biasanya perlu menentukan model data permintaan dan respons. Flask-RESTPlus menyediakan objek Model untuk mentakrifkan model dan menyediakan beberapa jenis medan biasa, seperti String, Integer, Boolean, dll.

@api.errorhandler
def handle_error(error):
    return {'message': str(error)}, 400

Dalam contoh di atas, kami mentakrifkan model yang dipanggil ExampleModel, yang mempunyai dua medan: id dan nama. Medan ini diperlukan.

5. Pengesahan data permintaan dan tindak balas

Menurut definisi model, Flask-RESTPlus boleh mengesahkan data permintaan dan tindak balas secara automatik. Kita boleh menggunakan penghias @api.expect untuk menentukan model data permintaan dan penghias @api.marshal_with untuk menentukan model data respons.

@api.route('/doc')
class APIDoc(Resource):
    def get(self):
        return api.documentation

Dalam contoh di atas, kita dapat melihat bahawa kita menggunakan penghias @api.expect untuk mengesahkan data yang diminta dan penghias @api.marshal_with untuk menentukan model data respons.

6. Pengendalian ralat

Apabila ralat API berlaku, kami harus mengembalikan respons ralat yang sesuai. Flask-RESTPlus menyediakan penghias yang sangat mudah untuk menangani ralat, penghias @api.errorhandler.
rrreee

Dalam contoh di atas, kami mentakrifkan fungsi handle_error() untuk mengendalikan ralat, dan kemudian gunakan penghias @api.errorhandler untuk menentukan fungsi pengendalian ralat.

7. API Berdokumen
    Flask-RESTPlus menyediakan antara muka Swagger terbina dalam untuk menjana dokumentasi API secara automatik. Kami hanya perlu mencipta laluan dokumen dalam aplikasi dan mengikatnya dengan objek API.
  • rrreee
  • Dalam contoh di atas, kami menentukan laluan yang dipanggil '/doc' dan mengikatnya dengan kelas APIDoc. Dalam kaedah get(), kami mengembalikan dokumentasi API.
🎜Kesimpulan: 🎜Dengan menggunakan Flask-RESTPlus, kami boleh membina dan mendokumentasikan API yang berkuasa dengan mudah. Artikel ini menerangkan cara memasang dan menyediakan Flask-RESTPlus, dan menyediakan beberapa contoh kod biasa. Saya harap artikel ini dapat membantu anda memahami dengan lebih baik dan menggunakan Flask-RESTPlus untuk membina API yang sangat baik. 🎜🎜Rujukan: 🎜🎜🎜Flask-RESTPlus dokumentasi rasmi: http://flask-restplus.readthedocs.io/🎜🎜

Atas ialah kandungan terperinci Cara membina API yang berkuasa menggunakan Flask-RESTPlus. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!

Kenyataan
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn
Python vs C: Aplikasi dan kes penggunaan dibandingkanPython vs C: Aplikasi dan kes penggunaan dibandingkanApr 12, 2025 am 12:01 AM

Python sesuai untuk sains data, pembangunan web dan tugas automasi, manakala C sesuai untuk pengaturcaraan sistem, pembangunan permainan dan sistem tertanam. Python terkenal dengan kesederhanaan dan ekosistem yang kuat, manakala C dikenali dengan keupayaan kawalan dan keupayaan kawalan yang mendasari.

Rancangan Python 2 jam: Pendekatan yang realistikRancangan Python 2 jam: Pendekatan yang realistikApr 11, 2025 am 12:04 AM

Anda boleh mempelajari konsep pengaturcaraan asas dan kemahiran Python dalam masa 2 jam. 1. Belajar Pembolehubah dan Jenis Data, 2.

Python: meneroka aplikasi utamanyaPython: meneroka aplikasi utamanyaApr 10, 2025 am 09:41 AM

Python digunakan secara meluas dalam bidang pembangunan web, sains data, pembelajaran mesin, automasi dan skrip. 1) Dalam pembangunan web, kerangka Django dan Flask memudahkan proses pembangunan. 2) Dalam bidang sains data dan pembelajaran mesin, numpy, panda, scikit-learn dan perpustakaan tensorflow memberikan sokongan yang kuat. 3) Dari segi automasi dan skrip, Python sesuai untuk tugas -tugas seperti ujian automatik dan pengurusan sistem.

Berapa banyak python yang boleh anda pelajari dalam 2 jam?Berapa banyak python yang boleh anda pelajari dalam 2 jam?Apr 09, 2025 pm 04:33 PM

Anda boleh mempelajari asas -asas Python dalam masa dua jam. 1. Belajar pembolehubah dan jenis data, 2. Struktur kawalan induk seperti jika pernyataan dan gelung, 3 memahami definisi dan penggunaan fungsi. Ini akan membantu anda mula menulis program python mudah.

Bagaimana Mengajar Asas Pengaturcaraan Pemula Komputer Dalam Kaedah Projek dan Masalah Dikemukakan Dalam masa 10 Jam?Bagaimana Mengajar Asas Pengaturcaraan Pemula Komputer Dalam Kaedah Projek dan Masalah Dikemukakan Dalam masa 10 Jam?Apr 02, 2025 am 07:18 AM

Bagaimana Mengajar Asas Pengaturcaraan Pemula Komputer Dalam masa 10 jam? Sekiranya anda hanya mempunyai 10 jam untuk mengajar pemula komputer beberapa pengetahuan pengaturcaraan, apa yang akan anda pilih untuk mengajar ...

Bagaimana untuk mengelakkan dikesan oleh penyemak imbas apabila menggunakan fiddler di mana-mana untuk membaca lelaki-dalam-tengah?Bagaimana untuk mengelakkan dikesan oleh penyemak imbas apabila menggunakan fiddler di mana-mana untuk membaca lelaki-dalam-tengah?Apr 02, 2025 am 07:15 AM

Cara mengelakkan dikesan semasa menggunakan fiddlerevery di mana untuk bacaan lelaki-dalam-pertengahan apabila anda menggunakan fiddlerevery di mana ...

Apa yang perlu saya lakukan jika modul '__builtin__' tidak dijumpai apabila memuatkan fail acar di Python 3.6?Apa yang perlu saya lakukan jika modul '__builtin__' tidak dijumpai apabila memuatkan fail acar di Python 3.6?Apr 02, 2025 am 07:12 AM

Memuatkan Fail Pickle di Python 3.6 Kesalahan Laporan Alam Sekitar: ModulenotFoundError: Nomodulenamed ...

Bagaimana untuk meningkatkan ketepatan segmentasi kata Jieba dalam analisis komen tempat yang indah?Bagaimana untuk meningkatkan ketepatan segmentasi kata Jieba dalam analisis komen tempat yang indah?Apr 02, 2025 am 07:09 AM

Bagaimana untuk menyelesaikan masalah segmentasi kata Jieba dalam analisis komen tempat yang indah? Semasa kami mengadakan komen dan analisis tempat yang indah, kami sering menggunakan alat segmentasi perkataan jieba untuk memproses teks ...

See all articles

Alat AI Hot

Undresser.AI Undress

Undresser.AI Undress

Apl berkuasa AI untuk mencipta foto bogel yang realistik

AI Clothes Remover

AI Clothes Remover

Alat AI dalam talian untuk mengeluarkan pakaian daripada foto.

Undress AI Tool

Undress AI Tool

Gambar buka pakaian secara percuma

Clothoff.io

Clothoff.io

Penyingkiran pakaian AI

AI Hentai Generator

AI Hentai Generator

Menjana ai hentai secara percuma.

Artikel Panas

R.E.P.O. Kristal tenaga dijelaskan dan apa yang mereka lakukan (kristal kuning)
3 minggu yang laluBy尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Tetapan grafik terbaik
3 minggu yang laluBy尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Cara Memperbaiki Audio Jika anda tidak dapat mendengar sesiapa
3 minggu yang laluBy尊渡假赌尊渡假赌尊渡假赌
WWE 2K25: Cara Membuka Segala -galanya Di Myrise
4 minggu yang laluBy尊渡假赌尊渡假赌尊渡假赌

Alat panas

SublimeText3 Linux versi baharu

SublimeText3 Linux versi baharu

SublimeText3 Linux versi terkini

mPDF

mPDF

mPDF ialah perpustakaan PHP yang boleh menjana fail PDF daripada HTML yang dikodkan UTF-8. Pengarang asal, Ian Back, menulis mPDF untuk mengeluarkan fail PDF "dengan cepat" dari tapak webnya dan mengendalikan bahasa yang berbeza. Ia lebih perlahan dan menghasilkan fail yang lebih besar apabila menggunakan fon Unicode daripada skrip asal seperti HTML2FPDF, tetapi menyokong gaya CSS dsb. dan mempunyai banyak peningkatan. Menyokong hampir semua bahasa, termasuk RTL (Arab dan Ibrani) dan CJK (Cina, Jepun dan Korea). Menyokong elemen peringkat blok bersarang (seperti P, DIV),

Muat turun versi mac editor Atom

Muat turun versi mac editor Atom

Editor sumber terbuka yang paling popular

DVWA

DVWA

Damn Vulnerable Web App (DVWA) ialah aplikasi web PHP/MySQL yang sangat terdedah. Matlamat utamanya adalah untuk menjadi bantuan bagi profesional keselamatan untuk menguji kemahiran dan alatan mereka dalam persekitaran undang-undang, untuk membantu pembangun web lebih memahami proses mengamankan aplikasi web, dan untuk membantu guru/pelajar mengajar/belajar dalam persekitaran bilik darjah Aplikasi web keselamatan. Matlamat DVWA adalah untuk mempraktikkan beberapa kelemahan web yang paling biasa melalui antara muka yang mudah dan mudah, dengan pelbagai tahap kesukaran. Sila ambil perhatian bahawa perisian ini

VSCode Windows 64-bit Muat Turun

VSCode Windows 64-bit Muat Turun

Editor IDE percuma dan berkuasa yang dilancarkan oleh Microsoft