Apakah amalan terbaik untuk menguji titik akhir API dalam kerangka web Python?

Gunakan klien ujian terbina dalam kerangka seperti app.test_client () dalam flask, testClient in FastAPI, atau klien di Django untuk mensimulasikan permintaan tanpa pelayan langsung. 2. Uji semua kaedah HTTP, termasuk kes kelebihan seperti input tidak sah, data yang hilang, akses yang tidak dibenarkan, dan had kadar, menggunakan parametrization untuk kejelasan. 3. Mengasingkan ujian dengan mengejek kebergantungan luaran dan menggunakan pangkalan data atau kilang dalam memori seperti Factory_boy untuk memastikan kelajuan dan determinisme. 4. Sentiasa mengesahkan kod status HTTP, format tindak balas, struktur JSON, dan mesej ralat, secara pilihan menggunakan skema JSON untuk respons kompleks. 5. Aliran Pengesahan dan Kebenaran Menguji dengan Benar dengan Mengesahkan Respons 401/403 dan menggunakan semula pelanggan yang disahkan melalui fungsi penolong. 6. Gunakan Pytest untuk kesederhanaan dan ciri -ciri kuatnya seperti lekapan, menganjurkan ujian ke dalam modul dan memanfaatkan conftest.py untuk persediaan bersama. 7. Ujian unit pelengkap dengan integrasi dan ujian akhir-ke-akhir yang mengesahkan aliran kerja penuh, termasuk interaksi pangkalan data dan middleware, walaupun lebih perlahan. 8. Automatikkan ujian dalam saluran paip CI/CD untuk menjalankan ujian, menyemak liputan, dan menguatkuasakan kualiti kod pada setiap permintaan tarik, memastikan kebolehpercayaan yang konsisten dan pengesanan bug awal.

Menguji titik akhir API dalam kerangka web Python harus teliti, automatik, dan disatukan ke dalam aliran kerja pembangunan anda. Sama ada anda menggunakan Flask, Fastapi, Django, atau rangka kerja lain, amalan terbaik berikut akan membantu memastikan API anda boleh dipercayai, selamat, dan dikekalkan.

1. Gunakan pelanggan ujian yang disediakan oleh rangka kerja

Kebanyakan kerangka web Python termasuk klien ujian yang mensimulasikan permintaan HTTP tanpa memulakan pelayan sebenar. Ini menjadikan ujian cepat dan terpencil.

• Flask : Gunakan app.test_client()
• Fastapi : Gunakan TestClient dari fastapi.testclient
• Django : Gunakan django.test.Client atau APITestCase dengan rangka kerja Django

Contoh (Fastapi):

 dari fastapi.testclient Import TestClient
dari aplikasi import myApp

Pelanggan = TestClient (App)

def test_read_item ():
    respons = client.get ("/item/1")
    menegaskan respons.status_code == 200
    menegaskan respons.json () ["id"] == 1

Pendekatan ini mengelakkan overhead rangkaian dan membolehkan kawalan penuh ke atas kitaran hayat permintaan.

2. Uji semua kaedah HTTP dan kes kelebihan

Jangan hanya menguji GET yang berjaya. Pastikan untuk menutup:

• Semua kata kerja HTTP ( GET , POST , PUT , DELETE , dll.)
• Input yang sah dan tidak sah
• Data hilang atau cacat
• Akses yang tidak dibenarkan (pengesahan/kebenaran)
• Mengehadkan kadar (jika berkenaan)
• Parameter pertanyaan dan variasi laluan URL

Contoh kes ujian:

• Menghantar POST dengan medan yang diperlukan
• Cuba mengakses laluan yang dilindungi tanpa tanda
• Memukul titik akhir yang terhad berkali-kali

Gunakan parametrization pytest atau unittest.subTest() untuk mengaturnya dengan bersih.

3. Mengasingkan ujian anda dengan mengejek dan lekapan

Elakkan memukul perkhidmatan luaran (contohnya, pangkalan data, API pihak ketiga) semasa ujian. Gunakan alternatif mengejek atau memori.

• Gunakan unittest.mock atau pytest-mock untuk menambal panggilan luaran
• Untuk pangkalan data, gunakan contoh SQLite dalam memori atau mengejek ORM
• Gunakan corak kilang (misalnya, factory_boy ) untuk menghasilkan data ujian

Contoh (mengejek panggilan pangkalan data):

 Dari Unittest.Mock Import Patch

@patch ("myapp.get_user_from_db")
def test_get_user (mock_db_call):
    mock_db_call.return_value = {"id": 1, "name": "alice"}
    respons = client.get ("/users/1")
    menegaskan respons.json () ["nama"] == "Alice"

Ini membuat ujian cepat dan deterministik.

4. Mengesahkan struktur tindak balas dan kod status

Selalu menegaskan:

• Kod Status HTTP (200, 404, 422, 403, dll.)
• Jenis Kandungan Respons ( application/json )
• Struktur JSON yang dijangkakan dan jenis medan
• Mesej ralat apabila sesuai

Alat seperti pydantic (dalam FastAPI) membantu menangkap respons tidak sah awal, tetapi pernyataan eksplisit masih diperlukan dalam ujian.

Contoh:

 menegaskan respons.status_code == 422
menegaskan "terperinci" dalam respons.json () # format ralat fastapi standard

Untuk tindak balas yang kompleks, pertimbangkan untuk menggunakan pengesahan skema JSON dalam ujian.

5. Pengesahan dan kebenaran ujian

Pastikan logik keselamatan anda berfungsi:

• Titik akhir yang memerlukan pulangan auth 401 apabila tidak ada token yang disediakan
• Token tidak sah ditolak
• Pengguna tidak dapat mengakses sumber yang tidak seharusnya (403)

Anda boleh membuat fungsi penolong untuk log masuk dan mengambil token:

 def get_auth_client (username = "testuser", password = "testpass"):
    Pelanggan = TestClient (App)
    token = login_and_get_token (pelanggan, nama pengguna, kata laluan)
    client.headers ["kebenaran"] = f "pembawa {token}"
    Kembali pelanggan

Kemudian gunakan semula pelanggan yang disahkan ini di seluruh ujian.

6. Gunakan pytest dan uji ujian dengan baik

pytest adalah kerangka ujian yang paling popular untuk Python. Ia menawarkan:

• Sintaks mudah
• Sokongan terbina dalam untuk lekapan
• Ekosistem Plugin Kaya ( pytest-cov , pytest-mock , dll.)

Struktur ujian anda seperti:

 ujian/
  test_users.py
  test_auth.py
  test_items.py
  conftest.py # SHARED FIXTURES

Gunakan lekapan dalam conftest.py untuk persediaan yang boleh diguna semula (misalnya, pangkalan data ujian, contoh klien).

7. Termasuk ujian integrasi dan akhir-ke-akhir

Walaupun ujian unit pantas, juga menjalankan ujian integrasi yang:

• Pukul pangkalan data sebenar (tetapi ujian)
• Mengesahkan aliran permintaan/tindak balas penuh
• Ujian middleware, pembalakan, atau mengehadkan kadar

Jalankan ini dalam suite yang berasingan jika mereka lebih perlahan, tetapi jangan melangkau mereka.

8. Automatikkan ujian dalam CI/CD

Mengintegrasikan ujian anda ke dalam saluran paip CI (Tindakan GitHub, Gitlab CI, dan lain -lain) sehingga setiap PR berjalan:

• Semua ujian
• Pemeriksaan liputan kod
• Pemeriksaan linting dan jenis (pilihan tetapi disyorkan)

Contoh Tindakan GitHub Langkah:

 - Nama: Jalankan ujian
  Jalankan: Pytest --Cov = MyApp

Bertujuan untuk liputan ujian yang tinggi, terutamanya pada titik akhir kritikal.

Pada asasnya, ujian API pepejal datang untuk menggunakan alat yang betul, mengasingkan kesan sampingan, meliputi penggunaan dunia nyata, dan mengautomasikan segala-galanya. Melekat pada amalan ini dan anda akan menangkap pepijat lebih awal dan menghantar lebih yakin.

Atas ialah kandungan terperinci Apakah amalan terbaik untuk menguji titik akhir API dalam kerangka web Python?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!