yii2-doc

YII2 接口文档工具
授权协议 GPL
开发语言 PHP
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 不详
投 递 者 聂溪叠
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

YII2接口文档工具:

使用注释自动生成基于YII2的接口文档,自动获取模型中注释。

安装方式

composer require chatfeed/yii2-doc "*"

配置

    'module'=>[
        'doc' => [
            'class' => 'cfd\doc\Module',
            'modelDescriptions'=>require __DIR__.'/model_description.php',
            'modelsMap'=>[
                '\common\base_models\kds\\',
            ]
        ]
    ]

用户自定义模型

return [
    'demo'=>[
        ['object','demo','模型'],
        ['integer','id','ID'],
        ['string','name','名称'],
        ['string','desc','描述'],
        ['integer','created_at','创建时间'],
        ['integer','updated_at','更新时间'],
    ]
];
  • 一直都在用yii1.1,也写过几个小项目,然后现在2.0出来了,懒得看文档重新学就直接用2.0照着别人写,最后还是写不下去了,想来从头好好看yii2.0。写这篇也算是笔记吧。 说说几个较大的改动点: 1. php 5.4的一些新特性都用上,包括命名空间,数组短语法等等。 2. 路径别名扩大至文件/目录路径和 URL,路径别名必须以 @ 符号开头,@yii 就是指向 Yii 安装目录的别名,Zend

  • <?php return [ 'id' => 'name', 'basePath' => dirname ( __DIR__ ), 'controllerNamespace' => 'path\path', 'bootstrap' => [ 'log', 'debug', 'gii' ],

  • <span style="font-size:18px;"><?php // comment out the following two lines when deployed to production // 定义 debug 的标记 defined('YII_DEBUG') or define('YII_DEBUG', true); // 定义环境,有 'dev' 和 'prod' 两种

  • 最近在学习yii2的框架,因为国内关于yii2框架的具体中文资料还是比较少,下面整理一些比较好的中文资料。 (1)yii2的底层和架构方面   a)http://www.yiichina.com/doc/guide/2.0 yii2的目前的官方中文社区文档,翻译还算是比较明白,最好从这里入手   b)http://www.yiichina.com/tutorial/773       yii2的关

  • 基于个人理解修改yii入口文件的位置 首先先将index.php  复制粘贴到根目录下 原index.php内容如下 <?php defined('YII_DEBUG') or define('YII_DEBUG', true); defined('YII_ENV') or define('YII_ENV', 'dev'); require(__DIR__ . '/../../vendor/au

  • composer安装 composer require "phpoffice/phpexcel": "*"  建一个上传模型Upload.php <?php namespace app\models; use Yii; use yii\base\Model; class Upload extends Model{ public $file; public function rul

  • yii2的框架,因为国内关于yii2框架的具体中文资料还是比较少,下面整理一些比较好的中文资料。 (1)yii2的底层和架构方面   a)http://www.yiichina.com/doc/guide/2.0 yii2的目前的官方中文社区文档,翻译还算是比较明白,最好从这里入手   b)http://www.yiichina.com/tutorial/773       yii2的关于底层方面

  • 一、安装 composer global require "fxp/composer-asset-plugin:1.0.0-beta4" 二、安装应用程序模板 composer create-project --prefer-dist yiisoft/yii2-app-basic basic 安装过程中,由于超出github限额,以前提示输入github账号和密码; 现在改为输入Token,按提示

  • 最近一直在做公司的项目-服务器层级间通信API和异步上传服务层,很久没写关于yii2的一些基础知识总结了。今天刚好有时间,就写一下控制器中的action部分。 1、什么是内联操作,什么是独立操作。 操作通常是用来执行资源的特定操作,因此,操作ID通常为动词,如view, update等。 内联操作: 操作方法的名字是根据操作ID遵循如下规则衍生: 将每个单词的第一个字母转为大写; 去掉中横杠; 增

  • 常用操作 //返回id为1对应的行  $user = Yii::$app->db->createCommand('SELECT * FROM oc_user WHERE id=1')->queryOne(); //返回oc_user表的所有数据  $user = Yii::$app->db->createCommand('SELECT * FROM oc_user')->queryAll(); /

  • DIRECTORY STRUCTURE 目录结构 -------------------       assets/             contains assets definition 包含资源定义       commands/           contains console commands (controllers) 包含命令行命令,控制器       config/    

  • 当你在调用all()方法时,它将返回一个以连续的整型数值为索引的数组。 而有时候你可能希望使用一个特定的字段或者表达式的值来作为索引结果集数组。那么你可以在调用all()之前使用indexBy()方法来达到这个目的 // 以uid作为key值 $query = User::find() ->select(['uid', 'name']) ->indexBy('uid') -

  • Yii2的文档支持非常全面,包括官方文档、API文档、中文文档、社区论坛、社区博客等多种形式。在官方文档中,Yii2提供了详细的指南和教程,覆盖了各种主题和用例,例如框架概述、快速入门、MVC、数据操作、表单处理、认证和授权、RESTful API、测试和调试等。同时,Yii2还提供了完整的API文档,覆盖了框架中的所有类和方法,并提供了详细的文档和示例。此外,Yii2的中文文档也很丰富,由社区贡

 相关资料
  • 1. 标题栏 NT_UI.setHeader(name, style); 列表 可选值 背景色 颜色 悬浮色 大小 间距 圆角 标题栏 wrapper true 标题栏-客服头像 kefuLogo true true true 标题栏-客服名称 kefuName true 标题栏-客服个性签名 kefuSignature true 标题栏-最小化按钮 min true true 标题栏-关闭按钮

  • 初始化 xn('init') 停止默认初始化 xn('stopAutoInit'); 设置访客信息 // customerinfo的可选健值见下表 xn('setCustomerInfo', JSONObject customerinfo); 参数名称 类型 备注 默认值 uid String 用户id 无 uname String 用户名称 无 userlevel String 用户等级

  • 为方便 Cocos Creator 开发者调试和接入腾讯云游戏多媒体引擎产品 API,本文为通过 Cocos Service 服务面板,接入腾讯云 GME 的接口文档。 此文档对应 GME SDK 的版本为 2.5.2。 函数原型为 GME Cocos SDK 接口文档 中定义的接口,Cocos Service 接入时设置了一个全局变量 tencentGME.tencentGMEInst,可参考示

  • ethers.js 主要包含以下4个模块 : 钱包(Wallet) ,Providers ,合约 Contract 以及 工具包 utils 。 在使用接口之前,请先确保正确 引入 ethers.js , 以下是接口列表: 钱包类 Wallet 和 签名器 Signer Wallet 签名器(Signer) 接口 提供者 Provider 连接以太坊网络 属性 获取网络 获取账号信息 获取以太坊状

  • 1. PHP开发接口文档 1.1 发送消息 发送文本、图片、语音消息到小能服务器。 备注:http请求方式为POST方式,格式为XML。 使用样例: class SendMsg{ function send($message){ //发送消息地址 $url = "https://thirdparty.ntalker.com/wechat"; $header[] = "Content-type:

  • CabalPHP 支持接口文档自动生成。 编写好相关配置和文档注释后浏览器访问 http://127.0.0.1:9501/__docs 即可查看相关文档,注意检查自己的监听端口和IP。 点击这里访问示例文档 接口文档地址只能在debug环境(cabal.debug配置为true)下访问。 配置 文档相关配置在 conf/cabal.php // ... 'document' =

  • Bilibili API (For thrid-party) Documents 哔哩哔哩开放接口第三方文档,通过这个接口我们可以开发出很多基于网站的功能。

  • 1.1.1. 设备接口文档 1.1.1. 设备接口文档 1)调用方式 client http InternalService(grpc) ------------------------------------------------------------------------- http(带Authorization)