Bringen Sie Ihnen bei, wie man Apidoc in Laravel verwendet!

Die folgende Tutorial-Kolumne von Laravel wird Ihnen die Verwendung von Apidoc in Laravel vorstellen. Ich hoffe, dass es Freunden in Not hilfreich sein wird!

Offizielle Dokumentation von apidoc: http://apidocjs.com /#params

Schritt eins: Verwenden Sie den Befehl npm install apidoc -g
, um apidoc zu installieren.
Schritt 2: Erstellen Sie eine neue apidoc.json-Datei im Projektstammverzeichnis. Das Dateiinhaltsformat ist wie folgt:

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

wie gezeigt:

Schritt 3: Verwenden apidoc -i myapp/ -o apidoc/ -t mytemplate/"

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

Zum Beispiel: Ich möchte eine API-Datei aus den Dokumenten im app/Http/Controllers/Api/-Verzeichnis in public/api generieren. Der Befehl lautet wie folgt:

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

Wie gezeigt:

Die Verzeichnisstruktur ist wie in der Abbildung dargestellt:

Das obige ist der detaillierte Inhalt vonBringen Sie Ihnen bei, wie man Apidoc in Laravel verwendet!. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!