温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

laravel中使用apidoc

发布时间:2020-07-23 23:35:10 来源:网络 阅读:424 作者:jinjiang2009 栏目:开发技术

apidoc官方文档:http://apidocjs.com/#params

第一步:使用:npm install apidoc -g 
命令安装apidoc。 
第二步:在项目根目录下新建apidoc.json文件,文件内容格式参考如下:

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

如图:laravel中使用apidoc

第三步:使用apidoc -i myapp/ -o apidoc/ -t mytemplate/"

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

如:我要将app/Http/Controllers/Api/目录下的文档生成api文件到public/api的命令如下:

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

如图:laravel中使用apidoc

目录结构如图:laravel中使用apidoc


向AI问一下细节

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

AI