Erstellen Sie eine einfache API mit Laravel Dingo/API

In diesem Artikel wird hauptsächlich die Verwendung von Laravel Dingo/API zum Erstellen einer einfachen API vorgestellt, die einen gewissen Referenzwert hat. Jetzt kann ich sie mit allen teilen, die sie benötigen.

1. env-Konfigurationsdatei hinzugefügt

API_STANDARDS_TREE=vnd 
API_SUBTYPE=myapp
API_PREFIX=api
API_DOMAIN=null
API_VERSION=v1
API_NAME="My API"
API_CONDITIONAL_REQUEST=false
API_STRICT=false
API_DEBUG=true

Standards Tree Standards Tree

Es gibt drei verschiedene Bäume: x, prs und vnd. Der von Ihnen verwendete Standardbaum hängt von dem Projekt ab, das Sie entwickeln.

Der nicht registrierte Baum (x) repräsentiert hauptsächlich lokale und private Umgebungen.

Der private Baum (prs) repräsentiert hauptsächlich Projekte ohne kommerzielle Veröffentlichung.

Vendor Tree (vnd) repräsentiert hauptsächlich öffentlich veröffentlichte Projekte

Subtyp SUBTYPE

Ein Subtyp ist normalerweise der Kurzname einer Anwendung oder eines Projekts. Alle werden in Kleinbuchstaben geschrieben.

PRÄFIX (z. B. www.z5w.net/api/)

Wenn Sie jemals eine API verwendet haben, wissen Sie, dass die meisten Dienste von Subdomains oder Präfixen stammen. Präfix oder Subdomain ist erforderlich, aber nur eine ist erforderlich. Bitte vermeiden Sie die Verwendung von Versionsnummern als Präfix oder Subdomain, da die Versionierung über den Accept-Header erfolgt.

Subdomain-Name API_DOMAIN

Zum Beispiel kann api.z5w.net als API-Aufrufadresse verwendet werden. Wenn das Präfix festgelegt wurde, wird die Domäne im Allgemeinen auf null gesetzt

Versionsnummer Version

Diese Versionsnummer ist die Standardversionsnummer Ihrer API und wird verwendet Wird in einigen Fällen als Standardwert für Rückrufe verwendet, wenn keine Versionsnummer angegeben wird. Diese Versionsnummer wird auch als Standardwert beim Generieren der API-Dokumentation verwendet.

Name Name

Der Name Ihrer API wird nur verwendet, wenn Sie Dokumentation mit dem API Blueprint-Befehl generieren. Durch die Verwendung dieses Namens müssen Sie den Namen nicht jedes Mal manuell definieren, wenn Sie ein Dokument generieren.
Möglicherweise müssen Sie es in Anführungszeichen setzen.

Bedingte Anfrage CONDITIONAL_REQUEST

„Bedingte Anfrage“ ist standardmäßig aktiviert, was für den Caching-Mechanismus des Clients von Vorteil ist, um API-Anfragen nach Möglichkeit zwischenzuspeichern.

Strenger Modus STRICT

Der strikte Modus erfordert, dass der Client den Accept-Header anstelle der in der Konfigurationsdatei konfigurierten Standardversion sendet. Das bedeutet, dass Sie nicht direkt über Ihren Browser auf Ihre API zugreifen können.

Wenn der strikte Modus aktiviert ist, löst das Senden eines illegalen Accept-Headers eine nicht behandelte Ausnahme SymfonyComponentHttpKernelExceptionBadRequestHttpException aus. Sie müssen diese Ausnahme selbst behandeln.

Debug-Modus-Debug

Zu den häufigen Fehlern, die von diesem Paket behandelt werden, gehört ein Debug-Schlüssel, der, wenn er aktiviert ist, Stack-Trace-Details ausfüllt.

2. Fügen Sie eine Route in /routes/web.php hinzu

$api = app('Dingo\Api\Routing\Router');
$api->version('v1', function ($api) {
    $api->get('helloworld', 'App\Api\Controllers\HelloController@index');
});

3. Erstellen Sie die Datei /app/Api/Controllers/HelloController.php

<?php

namespace App\Api\Controllers;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class HelloController extends Controller
{
    public function index()
    {
        return &#39;{content:Helloworld!}&#39;;
    }
}

4. Testen Sie die Route: $ php artisan api:routes, wenn

+-----+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+
| Host | Method   | URI             | Name | Action                                    | Protected | Version(s) | Scope(s) | Rate Limit |
+------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+
|      | GET|HEAD | /api/helloworld |      | App\Api\Controllers\HelloController@index | No        | v1         |          |            |
+------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+

erscheint, bedeutet das Erfolg

Dann besuchen Sie http://www.*.com/api/helloworld, um zu sehen, ob die JSON-Daten vorhanden sind der API erscheint.

{content:Helloworld!}

Das Obige ist der gesamte Inhalt dieses Artikels. Ich hoffe, er wird für das Studium aller hilfreich sein. Weitere verwandte Inhalte finden Sie auf der chinesischen PHP-Website.

Verwandte Empfehlungen:

Laravel Dingo/API fügt JWT-Auth-Authentifizierung hinzu

Das obige ist der detaillierte Inhalt vonErstellen Sie eine einfache API mit Laravel Dingo/API. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!