FastOpenAPI telah muncul sebagai penyelesaian bagi pembangun yang menghargai pendekatan intuitif FastAPI untuk dokumentasi API tetapi perlu bekerja dengan rangka kerja web Python yang berbeza. Pustaka ini menjambatani jurang yang ketara dalam ekosistem web Python dengan membawa penjanaan skema OpenAPI yang konsisten merentasi pelbagai rangka kerja termasuk Flask, Falcon, Sanic, Starlette, dan Tornado.
Rangka Kerja yang Disokong
- Falcon
- Flask
- Quart
- Sanic
- Starlette
- Tornado
Ciri-ciri Utama
- Menjana skema OpenAPI dengan Pydantic v2
- Pengesahan data menggunakan model Pydantic
- Penghalaan proksi menyediakan penghalaan gaya FastAPI
- Sokongan untuk antara muka dokumentasi Swagger UI dan ReDoc
Pembangunan API Code-First vs. Spec-First
Perbincangan komuniti mengenai FastOpenAPI telah mencetuskan semula perdebatan antara pendekatan pembangunan API code-first dan spec-first. Pembangunan code-first, seperti yang dicontohkan oleh FastAPI dan kini FastOpenAPI, membolehkan pembangun menentukan API mereka secara langsung dalam kod dengan penghias (decorators) dan anotasi jenis. Pendekatan ini cenderung lebih intuitif untuk pembangun Python dan sejajar dengan sifat dinamik Python.
Sebaliknya, pembangunan spec-first melibatkan penciptaan dokumen spesifikasi OpenAPI terlebih dahulu, kemudian melaksanakan API berdasarkan spesifikasi tersebut. Walaupun pendekatan ini memerlukan lebih banyak kerja awal, ia menawarkan kelebihan untuk pasukan yang lebih besar dan API awam.
Spec-first adalah pendekatan pilihan saya akhir-akhir ini, tetapi saya perlu berkembang untuk memahaminya. Ia tidak masuk akal pada awalnya sehingga saya menulis kod berulang yang sama beratus kali dan menyedari berapa banyak masa yang saya sia-siakan. Kos awal lebih tinggi daripada 10 baris kod yang diperlukan untuk membuat aplikasi FastAPI yang berfungsi, tetapi setelah melepasi itu, ia menjadi penjimat masa yang besar.
Ramai pembangun menyatakan bahawa spec-first menjadi sangat bernilai dalam persekitaran kolaboratif di mana API perlu direka dan dikaji semula sebelum pelaksanaan, manakala code-first cemerlang dalam senario pembangunan pantas dan API peribadi di mana kelajuan pembangun individu diutamakan.
Fleksibiliti Rangka Kerja Tanpa Mengorbankan Dokumentasi
Satu kelebihan utama yang diketengahkan oleh ahli komuniti adalah keupayaan untuk mengekalkan kod sedia ada sambil mendapatkan dokumentasi gaya FastAPI. Beberapa pengulas menyebut tentang bekerja dengan aplikasi Flask lama bersama perkhidmatan FastAPI yang lebih baru, mewujudkan keperluan untuk dokumentasi yang konsisten merentasi rangka kerja yang berbeza.
FastOpenAPI menangani ini dengan menyediakan pendekatan bersatu untuk definisi laluan dan dokumentasi yang berfungsi merentasi pelbagai rangka kerja. Ini sangat bernilai bagi organisasi yang tidak dapat dengan mudah memindahkan semua perkhidmatan mereka kepada satu rangka kerja tetapi mahukan dokumentasi API yang konsisten.
Pelaksanaannya digambarkan sebagai lancar oleh pengguna, memerlukan perubahan minimum pada struktur kod sedia ada sambil memberikan manfaat besar dari segi dokumentasi, pengesahan, dan pengalaman pembangun.
Cabaran Ekosistem Async Python
Perbincangan juga menyentuh tentang cabaran yang lebih luas dalam ekosistem pengaturcaraan tak segerak (asynchronous) Python. Sesetengah pembangun menyatakan kekecewaan dengan perpecahan dalam ekosistem Python antara kod segerak dan tak segerak, menyatakan kesukaran penyahpepijatan dan isu keserasian.
Sokongan FastOpenAPI untuk rangka kerja segerak tradisional seperti Flask dan yang tak segerak seperti Sanic dan Starlette mencerminkan keadaan semasa pembangunan web Python, di mana kedua-dua paradigma wujud bersama dan dipilih berdasarkan keperluan projek tertentu.
Beberapa pengulas membincangkan kelebihan pelaksanaan asyncio Python berbanding alternatif seperti Gevent, menyoroti ketegangan berterusan dalam cara Python mengendalikan keserentakan. FastOpenAPI mengelak perdebatan ini dengan menyokong pelbagai rangka kerja tanpa mengira model keserentakan mereka.
Sokongan Rangka Kerja dan Pembangunan Masa Hadapan
Walaupun FastOpenAPI kini menyokong enam rangka kerja Python (Falcon, Flask, Quart, Sanic, Starlette, dan Tornado), ahli komuniti bertanya tentang sokongan rangka kerja tambahan, terutamanya untuk Django. Pembangun menunjukkan bahawa integrasi Django ada dalam pelan pembangunan tetapi menimbulkan cabaran unik kerana struktur projeknya.
Komuniti juga membincangkan ciri-ciri berpotensi seperti inferens model respons automatik dari jenis pulangan, yang akan mengurangkan lagi kod berulang. Pembangun menyatakan keterbukaan untuk menambah ciri-ciri tersebut dalam kemas kini masa depan.
FastOpenAPI mewakili evolusi menarik dalam ekosistem web Python, membawa aspek mesra pembangun FastAPI kepada pelbagai rangka kerja yang lebih luas. Dengan API web terus berkembang, alat yang memudahkan dokumentasi dan menyeragamkan corak pembangunan merentasi rangka kerja memenuhi keperluan penting untuk pasukan pembangunan yang bekerja dengan tumpukan teknologi yang pelbagai.
Rujukan: FastOpenAPI