PHP implementiert ein Open-Source-API-Verwaltungsplattformsystem

PHP implementiert ein Open-Source-API-Verwaltungsplattformsystem

Mit der kontinuierlichen Weiterentwicklung von Webdiensten ist die Web-API zu einem wichtigen Bestandteil der Web 2.0-Ära geworden. Die Web-API bietet viele Funktionen und Schnittstellen für Anwendungen, sodass wir verschiedene Anwendungen einfacher und bequemer erstellen können. Allerdings kann die Verwaltung und Wartung einer großen Anzahl von APIs Kopfschmerzen bereiten. Daher ist ein Open-Source-API-Verwaltungsplattformsystem unbedingt erforderlich.

In diesem Artikel wird erläutert, wie Sie mit PHP ein Open-Source-API-Verwaltungsplattformsystem implementieren.

Umgebungsvorbereitung

Um unser Open-Source-API-Management-Plattformsystem auszuführen, benötigen wir folgende Umgebungen:

1. PHP
2. MySQL
3. Apache/Nginx

Natürlich können Sie stattdessen auch andere Webserver verwenden von Apache oder Nginx.

System Framework

Wir verwenden das PHP-Framework Laravel, um unser Open-Source-API-Management-Plattformsystem aufzubauen. Laravel ist ein beliebtes PHP-Framework, das schön gestaltet und einfach zu verwenden und zu warten ist.

Laravel installieren

Installieren Sie die neueste Version von Laravel mit dem folgenden Befehl:

composer create-project --prefer-dist laravel/laravel api-manager

Dieser Befehl erstellt ein neues Projekt mit dem Namen api-manager im aktuellen Verzeichnisprojekt und installiert automatisch Laravel und die zugehörigen Abhängigkeiten.

Datenbank erstellen

Wir müssen eine Datenbank in MySQL erstellen und diese mit unserer Anwendung verknüpfen. Wir können den folgenden Befehl verwenden, um eine neue Datenbank in MySQL zu erstellen:

CREATE DATABASE api_manager;

Datenbankkonfigurationsinformationen aktualisieren

Öffnen Sie die .env-Datei des API-Manager-Projekts und aktualisieren Sie die folgenden Informationen auf Ihre MySQL-Verbindungsinformationen:

DB_HOST = 127.0.0.1 Wir können Swagger mit dem folgenden Befehl installieren:

composer require "darkaonline/swagger-lume:5.8.*"

Nach erfolgreicher Installation von Swagger müssen wir den folgenden Inhalt in die Datei config/app.php einfügen:

/ / Swagger Provider registrieren

$app->register(SwaggerLumeServiceProvider::class);

// Registrieren Publish

$app->configure('swagger-lume');

$app->register(SwaggerLumeServiceProvider:: class);

// Konfiguration, Ansichten und Assets veröffentlichen

$this->publishes([

__DIR__.'/../config/swagger-lume.php' => config_path('swagger-lume.php'),

], 'config');

Fügen Sie die Swagger-Ansicht zur Datei „routes/web.php“ der Anwendung hinzu:

$ router->get('/', function () use ($router) {

return view('swagger');

});

Dadurch wird die Swagger-Dokumentation unter unserem Anwendungsstammpfad angezeigt.

API-Controller erstellen

Wir müssen einen Controller in der API-Manager-Anwendung erstellen, um API-Anfragen zu verarbeiten. Mit dem folgenden Befehl können wir einen Controller erstellen:

php artisan make:controller ApiController

Dadurch wird eine neue Controller-Datei namens ApiController.php im Verzeichnis app/Http/Controllers erstellt.

Fügen Sie in der Datei ApiController.php den folgenden Code hinzu:

namespace AppHttpControllers;

use IlluminateHttpRequest;

class ApiController erweitert Controller

{

public function list()
{
    return response()->json(['status' => 'success', 'message' => 'API list']);
}

public function get($id)
{
    return response()->json(['status' => 'success', 'message' => 'API '.$id]);
}

public function create(Request $request)
{
    $name = $request->input('name');
    $url = $request->input('url');

    return response()->json(['status' => 'success', 'message' => 'API '.$name.' created']);
}

public function update(Request $request, $id)
{
    $name = $request->input('name');
    $url = $request->input('url');

    return response()->json(['status' => 'success', 'message' => 'API '.$id.' updated']);
}

public function delete($id)
{
    return response()->json(['status' => 'success', 'message' => 'API '.$id.' deleted']);
}

}

Der obige Code definiert die allgemeinen Betriebsmethoden der API für uns: auflisten, abrufen, erstellen, aktualisieren, löschen.

API-Routing-Konfiguration

Wir müssen den folgenden Code zur Datei „routes/api.php“ hinzufügen:

$router->group(['prefix' => 'api'], function () use ($ router) {

// List APIs
$router->get('list', 'ApiController@list');

// Get API
$router->get('get/{id}', 'ApiController@get');

// Create API
$router->post('create', 'ApiController@create');

// Update API
$router->put('update/{id}', 'ApiController@update');

// Delete API
$router->delete('delete/{id}', 'ApiController@delete');

});

Dies definiert für uns das Anforderungsrouting für jede API.

API testen

Wir können Tools wie Postman verwenden, um unsere API zu testen. In Postman können Sie die folgende Anforderungs-URL verwenden, um die API zu testen:

GET http://localhost:8000/api/list

GET http://localhost:8000/api/get/1

POST http:// localhost: 8000/api/create

PUT http://localhost:8000/api/update/1

DELETE http://localhost:8000/api/delete/1

Zum Schluss starten Sie den lokalen Server und führen den folgenden Befehl aus :

php artisanserve

Jetzt können wir http://localhost:8000/ im Browser öffnen, um unser Open-Source-API-Verwaltungsplattformsystem anzuzeigen. Gleichzeitig können wir auch unter http://localhost:8000/api auf unsere API zugreifen. In Swagger können wir die Dokumentation der API einsehen und verschiedene Funktionen der API testen.

Fazit

Es ist nicht schwierig, ein Open-Source-API-Verwaltungsplattformsystem mit PHP zu implementieren. Mithilfe des Laravel-Frameworks und der Swagger-Tools können wir ganz einfach ein vollständiges API-Management-Plattformsystem aufbauen.

Die Beherrschung des Open-Source-API-Managementplattformsystems wird Sie dazu führen, einen neuen Weg zu beschreiten und die Welt Ihrer Webanwendungen interessanter und aufregender zu gestalten.

Das obige ist der detaillierte Inhalt vonPHP implementiert ein Open-Source-API-Verwaltungsplattformsystem. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!