Quantcast
Channel: cc :: somkiat
Viewing all articles
Browse latest Browse all 1997

การจัดการ OpenAPI ใน FastAPI แบบง่าย ๆ

$
0
0

เนื่องจากมีปัญหาในจัดการ OpenAPI หรือ Swagger ที่คุ้นเคยใน FastAPI กันดังนี้

  • ต้องการจัดกลุ่มของ API แต่ละตัวตาม
  • อยากให้แยกไฟล์ของ OpenAPI ตามกลุ่มของ API

เลยลองมาทำดูแบบง่ายกันหน่อย

เรื่องที่ 1 แบ่งกลุ่มของ API ให้สวย ๆ

เรื่องนี้ไม่ยากเพียงแค่เพิ่ม tag เข้าไปตรงการกำหนด router ก็ได้เลย
ดูในเอกสารได้เลย
ตัวอย่างการใช้งานแบบง่าย ๆ

[gist id="61127a09b7531867e1bb2e87a833e1e9" file="1.py"]

เพื่อให้สวยงามขึ้น สร้าง class จัดการ tags กันนิดหน่อย

[gist id="61127a09b7531867e1bb2e87a833e1e9" file="2.py"]

แสดงผลการทำงานดังรูป

เรื่องที่ 2 แยกไฟล์ตามกลุ่มของ API ไปเลย

ในส่วนนี้ FastAPI เตรียม Sub application ไว้ให้ใช้งาน
เราสามารถแบ่งไฟล์ของ OpenAPI ตามกลุ่มได้เลย

ยกตัวอย่างเช่น ต้องการเพิ่ม extra api เข้ามา
สามารถทำได้ดังนี้

[gist id="61127a09b7531867e1bb2e87a833e1e9" file="3.py"]

สามารถเข้าดู OpenAPI ของ extra api ผ่าน url=http://127.0.0.1:8000/extra/docs

ดูเอกสารเพิ่มเติมในส่วนของ Advance documentation
อธิบายไว้ได้ละเอียดมาก ๆ
ขอให้สนุกกับการ coding



Viewing all articles
Browse latest Browse all 1997

Trending Articles