sheng/yii2doc

yii2接口文档生成

v0.1 2018-04-10 10:48 UTC

Requires

• yiisoft/yii2: 2.0.15.1

GPL-3.0

• David Lee

• php
• doc
• yii2
• api-doc

README

效果

INSTALLATION

composer require sheng/yii2doc

demo

get参数可以使用query-param 也可以用request-param + http-method get request-param 会根据http-method 配置自动从请求的params 或者form中获取

/**
 * 这个里是接口名/接口说明
 * @http-method get
 * @request-param string $business_id 业务线id required
 * @request-param string $keyword 关键字(element.code, element.name, org.id)
 * @return array
 */
 public function actionIndex(){}

/**
 * 一条业务线元素列表
 * @http-method get
 * @query-param string $business_id 业务线id required
 * @query-param string $keyword 关键字(element.code, element.name, org.id)
 * @return array
 */
 public function actionIndex(){}

form字段参数

/**
 * 这个里是接口名/接口说明
 * @http-method post
 * @form-param string $business_id 业务线id required
 * @form-param string $keyword 关键字(element.code, element.name, org.id)
 * @return array
 */
 public function actionIndex(){}

/**
 * 这个里是接口名/接口说明
 * @http-method delete
 * @request-param string $business_id 业务线id required
 * @return array
 */
 public function actionIndex(){}

/**
 * 这个里是接口名/接口说明
 * @http-method put
 * @body-param array $body httpbody required
 * @return array
 */
 public function actionIndex(){}

接口分组现在是根据controller分组的

/**
* 第一行注释即为接口分组名
*
*/
class IndexController{}

swagger

https://swagger.io/ https://github.com/swagger-api/swagger-js