Cara membina API RESTful menggunakan Flask

Dalam bidang pembangunan perisian hari ini, RESTful API telah menjadi komponen teras bagi banyak aplikasi, yang boleh menyediakan perkhidmatan yang boleh dipercayai, dipisahkan dan mudah diselenggara. Flask ialah rangka kerja web Python ringan yang menyediakan cara yang fleksibel untuk membina aplikasi web serta API RESTful. Dalam artikel ini, kami akan memperkenalkan cara menggunakan Flask untuk membina API RESTful.

1. Install Flask

Mula-mula, anda perlu memastikan Python dan pip dipasang. Buka terminal atau command prompt pada sistem anda dan masukkan arahan berikut untuk memasang Flask:

pip install Flask

2. Buat folder projek

Dalam contoh ini, kami mencipta folder projek bernama Ia adalah folder projek "flask-restful". Masukkan arahan berikut dalam terminal untuk mencipta folder:

mkdir flask-restful

3. Cipta persekitaran maya

Adalah disyorkan untuk menggunakan persekitaran maya untuk mengelakkan pemasangan Flask secara global pada sistem, ini boleh Membantu kami membangunkan berbilang projek pada komputer yang sama. Masukkan arahan berikut dalam terminal untuk mencipta persekitaran maya:

python3 -m venv env

4. Aktifkan persekitaran maya

Untuk mengaktifkan persekitaran maya dalam terminal, masukkan arahan berikut:

Untuk Mac/Linux:

source env/bin/activate

Untuk Windows:

envScriptsctivate

5. Tambah kebergantungan yang diperlukan

Dalam aplikasi Flask, anda perlu gunakan perpustakaan flask_restful dan perpustakaan lain untuk melaksanakan permintaan API RESTful dengan selamat. Kebergantungan ini boleh dipasang menggunakan arahan pip dalam persekitaran maya:

pip install flask_restful
pip install flask_cors

6. Mencipta fail induk aplikasi

Sebelum mencipta RESTful API kami, kami perlu mencipta Aplikasi fail induk. Cipta fail bernama "app.py" dalam folder projek dan tambahkan kod berikut:

from flask import Flask
from flask_restful import Api, Resource, reqparse

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

users = [
    {
        "name": "Alice",
        "age": 22,
        "occupation": "Software Engineer"
    },
    {
        "name": "Bob",
        "age": 26,
        "occupation": "Data Analyst"
    },
    {
        "name": "Charlie",
        "age": 33,
        "occupation": "UI/UX Designer"
    }
]

class User(Resource):
    def get(self, name):
        for user in users:
            if(name == user["name"]):
                return user, 200
        return "User not found", 404

api.add_resource(User, "/user/<string:name>")

if __name__ == '__main__':
    app.run(debug=True)

Kod di atas mencipta contoh aplikasi Flask yang dipanggil "app" dan contoh dipanggil "api "flask_restful object. Ia juga mentakrifkan beberapa data untuk menyimpan maklumat pengguna. Dalam aplikasi ini, kami juga mentakrifkan kelas yang dipanggil "Pengguna", yang mewarisi daripada kelas "Sumber" flask_restful. Kelas Pengguna mentakrifkan dua kaedah - dapatkan dan hantar. Kami hanya melaksanakan kaedah get, yang digunakan untuk mendapatkan data pengguna dengan nama yang ditentukan. Akhir sekali, ikat kelas Pengguna pada /user/

7. Jalankan aplikasi

Dalam terminal atau command prompt, masukkan arahan berikut untuk melancarkan aplikasi:

python app.py

Kemudian, lawati http:/ //localhost:5000/user/Alice (atau nama pengguna lain) boleh mendapatkan data pengguna.

8. Tambah sokongan CORS

CORS singkatan kepada Perkongsian Sumber Silang Asal. Apabila menggunakan API RESTful, sokongan CORS boleh digunakan dalam persekitaran pembangunan untuk mengelakkan isu sumber merentas domain. Dalam aplikasi kami, kami menambah sokongan CORS menggunakan perpustakaan flask_cors. Untuk menambah sokongan CORS, cuma tambah kod berikut pada fail utama aplikasi anda:

from flask_cors import CORS

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

Kod ini ditambah selepas contoh aplikasi dan definisi api. Ia mengikat perisian tengah CORS kepada contoh aplikasi.

Kesimpulan

Dalam artikel ini, kami memperkenalkan cara membina API RESTful menggunakan Flask. Kami mulakan dengan memasang Flask, kemudian mencipta folder projek, persekitaran maya, menambah kebergantungan, dan mencipta fail aplikasi utama. Kami juga mempelajari cara menambah sokongan CORS untuk membantu menyelesaikan isu permintaan sumber silang asal. Kini anda boleh membina perkhidmatan API RESTful dengan mudah menggunakan Flask.

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