PHP implémente un système de plateforme de gestion d'API open source

PHP implémente un système de plateforme de gestion d'API open source

Avec le développement continu des services Web, l'API Web est devenue un élément important de l'ère du Web 2.0. L'API Web fournit de nombreuses fonctions et interfaces pour les applications, nous permettant de créer diverses applications plus simplement et plus facilement. Cependant, gérer et maintenir un grand nombre d’API peut s’avérer un véritable casse-tête. Par conséquent, un système de plateforme de gestion d’API open source est très nécessaire.

Cet article expliquera comment utiliser PHP pour implémenter un système de plateforme de gestion d'API open source.

Préparation de l'environnement

Afin d'exécuter notre système de plateforme de gestion d'API open source, nous avons besoin des environnements suivants :

1. PHP
2. MySQL
3. Apache/Nginx

Bien sûr, vous pouvez également utiliser d'autres serveurs Web à la place d'Apache ou de nginx.

System Framework

Nous utilisons le framework PHP Laravel pour construire notre système de plateforme de gestion d'API open source. Laravel est un framework PHP populaire, magnifiquement conçu et facile à utiliser et à entretenir.

Installez Laravel

Installez la dernière version de Laravel à l'aide de la commande suivante :

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

Cette commande créera un nouveau projet nommé api-manager dans le projet de répertoire et installer automatiquement Laravel et ses dépendances associées.

Créer une base de données

Nous devons créer une base de données dans MySQL et l'associer à notre application. Nous pouvons utiliser la commande suivante pour créer une nouvelle base de données dans MySQL :

CREATE DATABASE api_manager;

Mettre à jour les informations de configuration de la base de données

Ouvrez le fichier .env du projet api-manager et mettez à jour les informations suivantes avec vos informations de connexion MySQL :

DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=api_manager
DB_USERNAME=root
DB_PASSWORD=

Installer et configurer Swagger

Swagger est un outil de documentation API populaire qui peut nous aider à mieux organiser et afficher la documentation API. Nous pouvons installer Swagger en utilisant la commande suivante :

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

Après avoir installé Swagger avec succès, nous devons ajouter le contenu suivant dans le fichier config/app.php :

/ / Enregistrez le fournisseur Swagger
$app->register(SwaggerLumeServiceProvider::class);

// Enregistrez-vous Publier
$app->configure('swagger-lume');
$app->register(SwaggerLumeServiceProvider:: class);

// Publier la configuration, les vues et les actifs
$this->publishes([

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

], 'config');

Ajouter la vue Swagger au fichier routes/web.php de l'application :

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

return view('swagger');

});

Cela affichera la documentation Swagger sous le chemin racine de notre application.

Créer un contrôleur API

Nous devons créer un contrôleur dans l'application api-manager pour gérer les requêtes API. Nous pouvons créer un contrôleur en utilisant la commande suivante :

php artisan make:controller ApiController

Cela créera un nouveau fichier de contrôleur appelé ApiController.php dans le répertoire app/Http/Controllers.

Dans le fichier ApiController.php, ajoutez le code suivant :

namespace AppHttpControllers;

use IlluminateHttpRequest;

class ApiController extends 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']);
}

}

Le code ci-dessus définit les méthodes de fonctionnement courantes de l'API pour nous : répertorier, obtenir, créer, mettre à jour, supprimer.

Configuration du routage API

Nous devons ajouter le code suivant au fichier routes/api.php :

$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');

});

Cela définira pour nous le routage des requêtes pour chaque API.

Test de l'API

Nous pouvons utiliser des outils comme Postman pour tester notre API. Dans Postman, vous pouvez utiliser l'URL de requête suivante pour tester l'API :

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

Enfin, démarrez le serveur local et exécutez la commande suivante :

php artisan serve

Maintenant, nous pouvons ouvrir http://localhost:8000/ dans le navigateur pour voir notre système de plateforme de gestion d'API open source. Dans le même temps, nous pouvons également accéder à notre API sur http://localhost:8000/api. Dans Swagger, nous pouvons consulter la documentation de l'API et tester diverses fonctions de l'API.

Conclusion

Il n'est pas difficile de mettre en œuvre un système de plateforme de gestion d'API open source avec PHP. En utilisant le framework Laravel et les outils Swagger, nous pouvons créer très facilement un système complet de plate-forme de gestion d'API.

La maîtrise du système de plateforme de gestion d'API open source vous amènera à ouvrir une nouvelle voie et à rendre le monde de vos applications Web plus intéressant et passionnant.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!