Apprenez à utiliser apidoc dans Laravel !

La colonne tutorielle suivante de Laravel vous présentera comment utiliser apidoc dans laravel. J'espère qu'elle sera utile aux amis dans le besoin !

documentation officielle d'apidoc : http://apidocjs.com /#params

Première étape : utilisez : la commande npm install apidoc -g
pour installer apidoc.
Étape 2 : Créez un nouveau fichier apidoc.json dans le répertoire racine du projet. Le format du contenu du fichier est le suivant :

{
  "name": "laravel5 API文档",
  "version": "v1.0",
  "description": "本文档提供laravel5 商品，订单，收货地址，等API文档供嗨聊服务端开发人员作为参考，文档使用RESTfull风格，如有疑问请联系开发者",
  "apidoc": {
    "title": "laravel5 API文档",
    "url" : "http://http://www.learnlaravel5.com//api"
  }}

comme indiqué :

Étape 3 : Utilisez apidoc -i myapp/ -o apidoc/ -t mytemplate/"

其中：
-i 表示输入，后面是文件夹路径-o 表示输出，后面是文件夹路径默认会带上-c，在当前路径下寻找配置文件(apidoc.json)，如果找不到则会在package.json中寻找 "apidoc": { }
myapp/ 表示要生成api的源文档所在目录位置
mytemplete/ 表示要生成api到的目录位置

Par exemple : je souhaite générer un fichier API à partir des documents du répertoire app/Http/Controllers/Api/ vers public/api. La commande est la suivante :

apidoc -i app/Http/Controllers/Api/ -o public/api

Comme indiqué :

La structure des répertoires est telle qu'indiquée dans la figure :

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!