Heim PHP-Framework Laravel Laravel-Entwicklung: Wie verwende ich Laravel Swagger, um API-Dokumentation zu generieren?

Laravel-Entwicklung: Wie verwende ich Laravel Swagger, um API-Dokumentation zu generieren?

Jun 13, 2023 am 09:35 AM
laravel swagger api文档

Laravel-Entwicklung: Wie verwende ich Laravel Swagger, um API-Dokumentation zu generieren?

Die Arbeit mit der API-Dokumentation ist bei der Entwicklung von Webanwendungen oft eine mühsame, aber wesentliche Aufgabe. Verwenden Sie Swagger, um API-Dokumentation automatisch zu generieren und zu visualisieren. In der Laravel-Entwicklung können wir das Laravel Swagger-Erweiterungspaket verwenden, um auf einfache Weise Swagger-API-Dokumentation zu generieren. In diesem Artikel erfahren Sie, wie Sie Laravel Swagger mit Laravel verwenden.

  1. Installieren Sie Laravel Swagger.

Verwenden Sie Composer, um das Laravel Swagger-Erweiterungspaket zu installieren: . Verwenden Sie den folgenden Befehl, um die Veröffentlichung abzuschließen:

composer require darkaonline/l5-swagger
Nach dem Login kopieren
    Nachdem Sie den Veröffentlichungsbefehl ausgeführt haben, sehen Sie das Verzeichnis swagger-ui im Verzeichnis public/vendor Swagger UI alle Ressourcen.
  1. Fügen Sie als Nächstes die folgende Zeile zur Laravel-Konfigurationsdatei config/app.php hinzu:
php artisan vendor:publish --provider "L5SwaggerL5SwaggerServiceProvider"
Nach dem Login kopieren

    Swagger-Annotation hinzufügen

    public/vendor 目录下看到 swagger-ui 目录,这个目录中包含了 Swagger UI 的所有资源。

    接下来,在 Laravel 的配置文件 config/app.php 中添加以下行:

    'providers' => [
        ...
        L5SwaggerL5SwaggerServiceProvider::class,
    ],
    
    'aliases' => [
        ...
        'Swagger' => L5SwaggerFacadesL5Swagger::class,
    ],
    Nach dem Login kopieren
    1. 添加 Swagger 注释

    为了告诉 Laravel Swagger 没有推断的 API 格式,我们需要在代码中添加 Swagger 注释。这些注释可以让 Laravel Swagger 自动解析您的 API,并生成对应的文档。

    /**
     * @OAGet(
     *      path="/users",
     *      operationId="getUsersList",
     *      tags={"Users"},
     *      summary="Get list of registered users",
     *      description="Returns list of users",
     *      @OAResponse(response="200", description="successful operation"),
     *      @OAResponse(response=401, description="Unauthorized"),
     *      @OAResponse(response=403, description="Forbidden"),
     *      @OAResponse(response=404, description="Not Found"),
     *      @OAResponse(response=500, description="Internal Server Error")
     *     )
     */
    Nach dem Login kopieren

    在上面的示例中,我们使用 @OAGet 注释表示这是一个 GET 请求。path 注释定义 API 的路径。tagssummary 注释用于在 Swagger 文档中显示摘要和标签。最后,@OAResponse 注释示例了可能的响应状态。

    1. 在 Laravel 中查看 Swagger 文档

    在完成所有先前的步骤之后,我们可以使用以下 URL 来查看 Laravel Swagger 文档:

    http://your-app.dev/api/documentation
    Nach dem Login kopieren

    (请注意,如果您使用的是 Laravel 5.4 或以上版本,则无需定义 .dev,请改为使用 .testUm Laravel mitzuteilen, dass Swagger keine Schlussfolgerungen zieht Im API-Format müssen wir Swagger-Anmerkungen in den Code einfügen. Diese Annotationen ermöglichen es Laravel Swagger, Ihre API automatisch zu analysieren und entsprechende Dokumentation zu generieren.

    rrreee

    Im obigen Beispiel haben wir die Annotation @OAGet verwendet, um anzugeben, dass es sich um eine GET-Anfrage handelt. Die Annotation path definiert den Pfad zur API. Die Annotationen tags und summary werden zum Anzeigen von Zusammenfassungen und Tags in Swagger-Dokumenten verwendet. Schließlich veranschaulicht die Annotation @OAResponse mögliche Antwortzustände.

      Swagger-Dokumentation in Laravel anzeigen

      Nach Abschluss aller vorherigen Schritte können wir die folgende URL verwenden, um die Laravel Swagger-Dokumentation anzuzeigen:

      rrreee

      (Bitte beachten Sie, dass Sie bei Verwendung von For Laravel 5.4 oder höher, es ist nicht erforderlich, .dev zu definieren, bitte verwenden Sie stattdessen .test oder andere lokale Domänennamen)

      Starten Sie den Entwicklungsserver von Laravel und greifen Sie auf die oben genannte URL zu , sollten Sie die automatisch generierte Swagger-Dokumentation in Ihrem Browser sehen können. 🎜🎜In der Swagger-Dokumentation können Sie die definierte API anzeigen, die API basierend auf den der API hinzugefügten Swagger-Annotationen testen und mögliche Antwortzustände anzeigen. 🎜🎜Zusammenfassung🎜🎜In diesem Artikel haben wir gelernt, wie man mit dem Laravel Swagger-Erweiterungspaket ganz einfach Swagger-API-Dokumentation generiert. Zuerst haben wir Laravel Swagger installiert, dann Swagger gestartet und der API Swagger-Annotationen hinzugefügt. Abschließend haben wir uns die von Laravel Swagger erstellte Dokumentation angesehen. 🎜🎜Die Verwendung von Laravel Swagger kann den Aufwand für das manuelle Schreiben von API-Dokumentation erheblich reduzieren und mögliche Fehler und Inkonsistenzen vermeiden. Durch die Verwendung der Swagger-Benutzeroberfläche können wir die API einfacher anzeigen und testen und gleichzeitig eine entwicklerfreundliche Schnittstelle bereitstellen. 🎜

    Das obige ist der detaillierte Inhalt vonLaravel-Entwicklung: Wie verwende ich Laravel Swagger, um API-Dokumentation zu generieren?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

Heiße KI -Werkzeuge

Undresser.AI Undress

Undresser.AI Undress

KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover

AI Clothes Remover

Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Undress AI Tool

Undress AI Tool

Ausziehbilder kostenlos

Clothoff.io

Clothoff.io

KI-Kleiderentferner

AI Hentai Generator

AI Hentai Generator

Erstellen Sie kostenlos Ai Hentai.

Heißer Artikel

R.E.P.O. Energiekristalle erklärten und was sie tun (gelber Kristall)
1 Monate vor By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Beste grafische Einstellungen
1 Monate vor By 尊渡假赌尊渡假赌尊渡假赌
Will R.E.P.O. Crossplay haben?
1 Monate vor By 尊渡假赌尊渡假赌尊渡假赌

Heiße Werkzeuge

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

SublimeText3 chinesische Version

SublimeText3 chinesische Version

Chinesische Version, sehr einfach zu bedienen

Senden Sie Studio 13.0.1

Senden Sie Studio 13.0.1

Leistungsstarke integrierte PHP-Entwicklungsumgebung

Dreamweaver CS6

Dreamweaver CS6

Visuelle Webentwicklungstools

SublimeText3 Mac-Version

SublimeText3 Mac-Version

Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

Laravel – Handwerkerbefehle Laravel – Handwerkerbefehle Aug 27, 2024 am 10:51 AM

Laravel – Artisan Commands – Laravel 5.7 bietet eine neue Möglichkeit, neue Befehle zu behandeln und zu testen. Es enthält eine neue Funktion zum Testen von Handwerkerbefehlen und die Demonstration wird unten erwähnt?

Laravel – Artisan-Konsole Laravel – Artisan-Konsole Aug 27, 2024 am 10:51 AM

Laravel – Artisan Console – Das Laravel-Framework bietet drei Haupttools für die Interaktion über die Befehlszeile, nämlich Artisan, Ticker und REPL. In diesem Kapitel wird Artisan ausführlich erläutert.

Laravel – Paginierungsanpassungen Laravel – Paginierungsanpassungen Aug 27, 2024 am 10:51 AM

Laravel – Paginierungsanpassungen – Laravel enthält eine Paginierungsfunktion, die einem Benutzer oder Entwickler hilft, eine Paginierungsfunktion einzubinden. Der Laravel-Paginator ist in den Abfrage-Builder und Eloquent ORM integriert. Die Paginierungsmethode automatisch

Wie bekomme ich den Rückgabecode, wenn das Senden von E -Mails in Laravel fehlschlägt? Wie bekomme ich den Rückgabecode, wenn das Senden von E -Mails in Laravel fehlschlägt? Apr 01, 2025 pm 02:45 PM

Methode zum Abholen des Rücksendecode, wenn das Senden von Laravel -E -Mails fehlschlägt. Wenn Sie Laravel zur Entwicklung von Anwendungen verwenden, stellen Sie häufig Situationen auf, in denen Sie Überprüfungscodes senden müssen. Und in Wirklichkeit ...

Laravel -Zeitplanaufgabe wird nicht ausgeführt: Was soll ich tun, wenn die Aufgabe nicht nach Zeitplan ausgeführt wird: Befehl ausführen? Laravel -Zeitplanaufgabe wird nicht ausgeführt: Was soll ich tun, wenn die Aufgabe nicht nach Zeitplan ausgeführt wird: Befehl ausführen? Mar 31, 2025 pm 11:24 PM

Laravel -Zeitplan -Aufgabe Ausführen nicht reagierende Fehlerbehebung Bei Verwendung der Zeitplanung von Laravel -Zeitplänen werden viele Entwickler auf dieses Problem stoßen: Zeitplan: Run ...

Wie kann man in Laravel mit der Situation umgehen, in der Überprüfungscodes nicht per E -Mail gesendet werden? Wie kann man in Laravel mit der Situation umgehen, in der Überprüfungscodes nicht per E -Mail gesendet werden? Mar 31, 2025 pm 11:48 PM

Die Methode zum Umgang mit Laravels E -Mail -Versagen zum Senden von Verifizierungscode besteht darin, Laravel zu verwenden ...

So implementieren Sie die benutzerdefinierte Tabellenfunktion des Klickens, um Daten im DCAT -Administrator hinzuzufügen? So implementieren Sie die benutzerdefinierte Tabellenfunktion des Klickens, um Daten im DCAT -Administrator hinzuzufügen? Apr 01, 2025 am 07:09 AM

So implementieren Sie die Tabellenfunktion von benutzerdefiniertem Klicken, um Daten in dcatadmin (laravel-admin) hinzuzufügen, wenn Sie DCAT verwenden ...

Laravel – Dump-Server Laravel – Dump-Server Aug 27, 2024 am 10:51 AM

Laravel – Dump-Server – Der Laravel-Dump-Server wird mit der Version von Laravel 5.7 geliefert. Die Vorgängerversionen enthalten keinen Dump-Server. Der Dump-Server wird eine Entwicklungsabhängigkeit in der Laravel-/Laravel-Composer-Datei sein.

See all articles