So verwenden Sie die Swagger-Benutzeroberfläche, um die API-Dokumentation in FastAPI anzuzeigen

So verwenden Sie die Swagger-Benutzeroberfläche, um die API-Dokumentation in FastAPI anzuzeigen

Einführung:
In der modernen Webentwicklung ist die API ein integraler Bestandteil. Um die Entwicklung und Wartung zu erleichtern, müssen wir eine benutzerfreundliche und benutzerfreundliche API-Dokumentation bereitstellen, damit andere Entwickler unsere API verstehen und verwenden können. Swagger ist ein beliebtes API-Dokumentationsformat und -Tool, das eine interaktive Benutzeroberfläche bereitstellt, die die Details der API visuell anzeigen kann. In diesem Artikel zeige ich Ihnen, wie Sie die Swagger-Benutzeroberfläche in FastAPI verwenden, um die API-Dokumentation anzuzeigen.

1. Abhängigkeiten installieren
   Zuerst müssen wir FastAPI und die zugehörigen Abhängigkeiten installieren. Es kann mit dem folgenden Befehl installiert werden:

   pip install fastapi[all]

   Dadurch werden FastAPI und alle erforderlichen Abhängigkeiten installiert, einschließlich der Swagger-Benutzeroberfläche.

2. Erstellen einer FastAPI-Anwendung
   Als nächstes erstellen wir eine FastAPI-Anwendung. Schreiben Sie in eine neue Python-Datei den folgenden Code:

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

   Diese einfache Anwendung definiert eine Root-Route, die eine einfache „Hello World“-Nachricht zurückgibt.

3. Swagger-Benutzeroberfläche hinzufügen
   Um die Swagger-Benutzeroberfläche zu unserer Anwendung hinzuzufügen, müssen wir die relevanten FastAPI-Komponenten importieren. Fügen Sie den folgenden Code zu unserer App-Datei hinzu:

   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")

   Im Code erstellen wir eine benutzerdefinierte Funktion namens custom_swagger_ui_html. Diese Funktion verwendet die von FastAPI bereitgestellte Funktion get_swagger_ui_html, um die HTML-Seite der Swagger-Benutzeroberfläche zu generieren. Wir haben auch einige URLs und Pfade zu statischen Dateien für die Swagger-Benutzeroberfläche definiert. 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

Führen Sie die App aus
Jetzt ist unsere App fertig und wir können sie ausführen. Verwenden Sie im Terminal den folgenden Befehl, um die Anwendung zu starten:

rrreee

Dadurch wird unsere Anwendung gestartet und lokal unter der Standardadresse http://localhost:8000 ausgeführt.

🎜🎜API-Dokumentation anzeigen🎜Öffnen Sie http://localhost:8000/swagger im Browser. Sie sehen eine interaktive Swagger-Benutzeroberfläche. Es werden die Details Ihrer API angezeigt, einschließlich Routing, Anforderungs- und Antwortmodellen und mehr. 🎜🎜🎜Fazit: 🎜Durch die Verwendung von FastAPI und Swagger UI können wir unsere API-Dokumentation einfach anzeigen und durchsuchen. Dies erleichtert Entwicklern das Verständnis und die Verwendung unserer API. Ich hoffe, dieser Artikel kann Ihnen dabei helfen, die Swagger-Benutzeroberfläche zum Anzeigen von API-Dokumenten in FastAPI zu verwenden. 🎜🎜Das Obige ist eine Anleitung zur Verwendung der Swagger-Benutzeroberfläche zum Anzeigen von API-Dokumenten in FastAPI. Ich hoffe, dieser Artikel wird Ihnen hilfreich sein. Danke fürs Lesen! 🎜

Das obige ist der detaillierte Inhalt vonSo verwenden Sie die Swagger-Benutzeroberfläche, um die API-Dokumentation in FastAPI anzuzeigen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!