apidoc

  1. 安装apidoc

     ```sh
 npm install apidoc -g #此时会报错
 官方解释: 
 The release notes below are annotated with the main breaking changes. Note that because this new version of Node.js is shipping with a new version of V8, existing native addons will need to be recompiled or runtime errors will occur when trying to load them. Use npm rebuild or simply remove your node_modules and npm install from scratch.
 #所以简单的解决方案就是, 降级为lts版本.
 #在nodejs.org上面下载nodejs. 别下载最新版, 下载老的longterm版. 此处坑爹.
 ```

  2. 在laravel的上层目录, 生成apidoc:

      apidoc -i laravel/app -o ./laravel/public/apidoc
  #laravel里面
  apidoc -i app -o public/apidoc
  ##要注意看他的输出, 一般都有用, 指明了错误.

  3. apiidoc的注释里面, 有中括号的参数是可选参数.

  4. apidoc.json是json格式, 最后一个项目不能有逗号.

      {
    "name" : "开放平台接口文档",
    "version": "1.0.0",
    "title": "开放平台接口文档",
    "description": "测试环境域名: http://test.openapi.huji8.com",
    "sampleUrl": "http://openapi.huji88.com" #这里不能有逗号.
  }

    ​

  5. 结论: 这货不如swagger.io好用. swagger=openapi + chrome postman.

  6. 结论其实不对.

可以直接制作测试连接: http://blog.qiji.tech/archives/15601
http://blog.csdn.net/lvbaolin123/article/details/52671677

项目根目录下的apidoc.json文件，打开它，将下面的信息添加进去。
"sampleUrl": "http://coolcodeapi.wodetiku.com"
这行文字的作用是apiDoc将会通过这个url来进行API测试，这样所有的API都会以这个url为前缀创建测试链接，并且还包含我们上面所说的Header，如果API文档设置有参数的话，参数也会一并显示出来。

postman

chrome安装插件postman laucher, 一个绿色的地球.
这里可以安装独立app: https://www.getpostman.com/app/download/osx64
建议使用独立app, postman的插件有莫名不传参数的问题.

以laravel为例: http://openapi.oksir.dev/trade/orderUpdate
  1. openapi.oksir.dev是配置在.env里面的. nginx配置的通配符.oksir.dev
  2. trade/orderupdata就是openapi里面写的.
  3. openapi的访问地址就可以直白的访问他的目录: http://oksir.dev/apidoc

数组参数

在posteman的输入
  • source[0[name]]
  • source[0[id]]
  • source[1[name]]
  • source[1[id]]
在代码里面
  • 就当数组塞进去, 就当数组取出来.
  • 还是比较方便的.