Utilisation d'ApiDoc

Cet article vous présente l'utilisation d'ApiDoc. Les amis intéressés peuvent y jeter un œil

Explication

apiDoc creates a documentation from API annotations in your source code

apiDoc est un document d'interface et comment il est créé C'est un commentaire d'interface. en fonction de votre code source. Il nous suffit d'écrire la documentation correspondante pour l'interface, puis d'utiliser l'outil de documentation de l'interface de génération apiDoc pour générer la documentation afin de faciliter la gestion et la visualisation.

Méthode de configuration

1. Installez apidoc (qu'est-ce que npm ??? Demandez à vos camarades de classe front-end.)

npm install apidoc -g

Installer le serveur http

npm install http-server -g

2. Ajoutez la documentation (exemple officiel) à l'interface et ajoutez-la devant la méthode de saisie du contrôleur.

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */

3. Créez apidoc.json (exemple officiel)

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "apidoc": {
    "title": "Custom apiDoc browser title",
    "url" : "https://api.github.com/v1"
  }
}

4. Générez apiDoc

apidoc -i app/Http/Controllers -o apidoc/

5.

Remarques supplémentaires

http-server api/doc

Référence

http://apidocjs.com/

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!