在laravel中使用apidoc的示例

这篇文章将为大家详细讲解有关在laravel中使用apidoc的示例,小编觉得挺实用的,因此分享给大家做个参考,希望大家阅读完这篇文章后可以有所收获。

目前创新互联建站已为上千家的企业提供了网站建设、域名、雅安服务器托管网站托管运营、企业网站设计、玄武网站维护等服务,公司将坚持客户导向、应用为本的策略,正道将秉承"和谐、参与、激情"的文化,与客户和合作伙伴齐心协力一起成长,共同发展。

第一步:使用: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"
  }}

如图:在laravel中使用apidoc的示例

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

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

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

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

如图:在laravel中使用apidoc的示例

目录结构如图:在laravel中使用apidoc的示例

关于“在laravel中使用apidoc的示例”这篇文章就分享到这里了,希望以上内容可以对大家有一定的帮助,使各位可以学到更多知识,如果觉得文章不错,请把它分享出去让更多的人看到。


当前标题:在laravel中使用apidoc的示例
网页网址:http://bzwzjz.com/article/gspood.html

其他资讯

Copyright © 2007-2020 广东宝晨空调科技有限公司 All Rights Reserved 粤ICP备2022107769号
友情链接: 成都网站设计 定制网站设计 成都网站建设 成都网站制作 成都响应式网站建设公司 成都营销网站建设 成都网站制作 企业网站设计 高端网站设计 响应式网站设计 成都网站建设 成都网站设计 重庆网站制作 成都网站制作 成都响应式网站建设 网站建设 公司网站建设 成都网站设计制作公司 成都网站建设 阿坝网站设计 企业网站建设公司 广安网站设计