Cara menggunakan UI Swagger untuk memaparkan dokumentasi API dalam FastAPI

Cara menggunakan Swagger UI untuk memaparkan dokumentasi API dalam FastAPI

Pengenalan:
Dalam pembangunan web moden, API adalah bahagian penting. Untuk memudahkan pembangunan dan penyelenggaraan, kami perlu menyediakan dokumentasi API yang mesra dan mudah digunakan supaya pembangun lain boleh memahami dan menggunakan API kami. Swagger ialah format dan alat dokumentasi API yang popular yang menyediakan antara muka UI interaktif yang boleh memaparkan butiran API secara visual. Dalam artikel ini, saya akan menunjukkan kepada anda cara menggunakan Swagger UI dalam FastAPI untuk memaparkan dokumentasi API.

1. Pasang kebergantungan
   Pertama, kita perlu memasang FastAPI dan kebergantungan yang berkaitan. Ia boleh dipasang menggunakan arahan berikut:

   pip install fastapi[all]

   Ini akan memasang FastAPI dan semua kebergantungan yang diperlukannya, termasuk UI Swagger.

2. Membuat aplikasi FastAPI
   Seterusnya, kami akan mencipta aplikasi FastAPI. Dalam fail Python baharu, tulis kod berikut:

   from fastapi import FastAPI
   
   app = FastAPI()
   
   @app.get("/")
   async def root():
    return {"message": "Hello World"}

   Aplikasi mudah ini mentakrifkan laluan akar yang mengembalikan mesej ringkas "Hello World".

3. Tambah UI Swagger
   Untuk menambah UI Swagger pada aplikasi kami, kami perlu mengimport komponen FastAPI yang berkaitan. Tambahkan kod berikut pada fail apl kami:

   from fastapi import FastAPI
   from fastapi.openapi.utils import get_openapi
   from fastapi.openapi.docs import get_swagger_ui_html
   
   app = FastAPI()
   
   @app.get("/")
   async def root():
    return {"message": "Hello World"}
   
   def custom_swagger_ui_html(*, request):
    openapi_url = app.openapi_url
    swagger_url = openapi_url.replace("/openapi.json", "/swagger")
    return get_swagger_ui_html(
        openapi_url=openapi_url,
        title=app.title + " - Swagger UI",
        oauth2_redirect_url=swagger_url + "/oauth2-redirect.html",
        swagger_js_url="/static/swagger-ui-bundle.js",
        swagger_css_url="/static/swagger-ui.css",
    )
   
   app.openapi = get_openapi(title="My API")
   
   @app.get("/swagger", include_in_schema=False)
   async def swagger_ui_html(request: Request):
    return custom_swagger_ui_html(request=request)
   
   app.mount("/static", StaticFiles(directory="static"), name="static")

   Dalam kod, kami mencipta fungsi tersuai yang dipanggil custom_swagger_ui_html. Fungsi ini akan menggunakan fungsi get_swagger_ui_html yang disediakan oleh FastAPI untuk menjana halaman HTML UI Swagger. Kami juga menentukan beberapa URL dan laluan ke fail statik untuk UI Swagger. custom_swagger_ui_html的自定义函数。这个函数将使用FastAPI提供的get_swagger_ui_html函数来生成Swagger UI的HTML页面。我们还为Swagger UI定义了一些URL和静态文件的路径。

4. 运行应用
   现在我们的应用已经准备就绪，可以运行它了。在终端中，使用以下命令来启动应用：

   uvicorn main:app --reload

   这将启动我们的应用，并使其运行在本地的默认地址http://localhost:8000上。

5. 查看API文档
   在浏览器中打开http://localhost:8000/swagger

Jalankan Apl
Kini apl kami sedia dan kami boleh menjalankannya. Dalam terminal, gunakan arahan berikut untuk memulakan aplikasi:

rrreee

Ini akan memulakan aplikasi kami dan menjadikannya berjalan secara setempat pada alamat lalai http://localhost:8000.

🎜🎜Lihat dokumentasi API🎜Buka http://localhost:8000/swagger dalam penyemak imbas, anda akan melihat antara muka UI Swagger yang interaktif. Ia akan memaparkan butiran API anda, termasuk penghalaan, model permintaan dan tindak balas, dan banyak lagi. 🎜🎜🎜Kesimpulan: 🎜Dengan menggunakan FastAPI dan UI Swagger, kami boleh memaparkan dan menyemak imbas dokumentasi API kami dengan mudah. Ini memudahkan pembangun memahami dan menggunakan API kami. Saya harap artikel ini dapat membantu anda menggunakan Swagger UI untuk memaparkan dokumen API dalam FastAPI. 🎜🎜Di atas ialah panduan tentang cara menggunakan Swagger UI untuk memaparkan dokumen API dalam FastAPI. Semoga artikel ini dapat membantu anda. Terima kasih kerana membaca! 🎜

Atas ialah kandungan terperinci Cara menggunakan UI Swagger untuk memaparkan dokumentasi API dalam FastAPI. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!