Laravel에서 apidoc을 사용하는 방법을 가르쳐주세요!

다음 튜토리얼 칼럼인 Laravel에서는 laravel에서 apidoc을 사용하는 방법을 소개하겠습니다. 도움이 필요한 친구들에게 도움이 되길 바랍니다!

apidoc 공식 문서: http://apidocjs.com/#params

1단계: 사용: npm install apidoc -g
apidoc을 설치하는 명령입니다.
2단계: 프로젝트 루트 디렉터리에 새 apidoc.json 파일을 생성합니다. 파일 내용 형식은 다음과 같습니다. 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"
  }}

如图：

第三步：使用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

3단계: apidoc 사용 - i myapp/ -o apidoc/ -t mytemplate/"

예: app/Http/Controllers/Api/ 디렉터리의 문서에서 api 파일을 생성하고 싶습니다. public/api 코드>의 명령은 다음과 같습니다: <img src="https://img.php.cn/upload/article/000/000/020/12d3f165fba206b1a242f333fc8bfdf9-2.png" alt="Laravel에서 apidoc을 사용하는 방법을 가르쳐주세요!" title="">rrreee

위 내용은 Laravel에서 apidoc을 사용하는 방법을 가르쳐주세요!의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!