Comment utiliser ThinkPHP6 pour la gestion des documents de l'interface API ?

Avec le développement d'Internet, l'API Web (Application Programming Interface) devient de plus en plus courante et importante. Pour un fournisseur d’API Web, il est indispensable de rédiger une documentation API complète et facile à comprendre. Actuellement, il existe de nombreux outils permettant de générer facilement de la documentation API, le plus populaire étant Swagger. Mais dans cet article, je me concentrerai sur la façon d'utiliser l'interface de gestion des documents API fournie dans le framework ThinkPHP6 pour gérer les documents API.

1. Installer l'extension de gestion de documents

Tout d'abord, nous devons installer l'extension de gestion de documents API dans le projet ThinkPHP6, qui s'appelle "topthink/penser-apidoc". Vous pouvez utiliser l'outil de ligne de commande Composer dans le répertoire racine du projet pour installer :

composer require topthink/think-apidoc

2. Write API interface document

Une fois l'installation terminée , nous le ferons. Vous pouvez commencer à rédiger la documentation de l'interface API. Dans ThinkPHP6, nous pouvons utiliser des annotations dans les méthodes du contrôleur pour écrire des documents d'interface API. Par exemple :

/**
 * 获取用户信息
 *
 * @ApiTitle    (获取用户信息)
 * @ApiSummary  (通过用户ID获取用户信息)
 * @ApiMethod   (GET)
 * @ApiRoute    (/user/:id)
 * @ApiParams   (name="id", type="integer", required=true, description="用户ID")
 * @ApiReturn   ({"code": 200, "msg": "success", "data": {"id": 1, "name": "张三", "age": 18}})
 * @ApiHeaders  (name="Authorization", type="string", required=true, description="用户授权Token")
 */
public function getUserInfo($id)
{
    // TODO: 获取用户信息的逻辑
}

Dans les commentaires ci-dessus, nous avons utilisé différentes annotations pour décrire l'interface API :

• @ApiTitle : Nom de l'interface
# 🎜 🎜#@ApiSummary : Introduction à l'interface
@ApiMethod : Méthode de requête (GET, POST, PUT, etc.)
@ApiRoute : Routage d'interface (tel que " /user/:id" , où ":id" représente les paramètres dynamiques)
@ApiParams : paramètres d'interface, y compris le nom du paramètre, le type de paramètre, s'il est requis et la description du paramètre, etc. #🎜🎜 #
• @ApiReturn : La valeur de retour de l'interface, y compris le format de la valeur de retour et la description de la valeur de retour
• @ApiHeaders : informations d'en-tête de l'interface (telles que l'autorisation)
Avec les commentaires ci-dessus, nous pouvons décrire clairement les informations de base d'une interface API.

Générer la documentation de l'API

Après avoir écrit le document d'interface API, nous pouvons utiliser l'outil de ligne de commande fourni par ThinkPHP6 pour générer le document API. Exécutez simplement la commande suivante dans le répertoire racine du projet :

php think apidoc --module api --path ./public/apidoc --type json

Dans la commande ci-dessus, nous précisons le chemin de stockage d'apido et le type de document généré (le format json est sélectionné ici). Notez que nous avons également spécifié le paramètre --module comme "api", ce qui signifie que nous générons uniquement la documentation API pour le module "api". Dans les applications réelles, vous pouvez choisir en fonction de vos besoins.

Après avoir exécuté la commande ci-dessus, nous pouvons trouver le document API généré dans le chemin de stockage spécifié. À ce stade, nous pouvons les transmettre aux utilisateurs de l'interface pour leur permettre de comprendre les informations de base de l'interface API.

Questions de réflexion :

Si vous utilisez l'extension de gestion documentaire dans un projet existant et ajoutez des commentaires aux contrôleurs et méthodes correspondants, alors Si vous effectuez à nouveau la troisième étape, que vous attendez-vous à ce que le document d'interface API généré ressemble à ?

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!