• 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    迪恩网络公众号

    yii2-fast-api: 快速配置并开发基于yii2的api服务

    原作者: [db:作者] 来自: 网络 收藏 邀请

    开源软件名称:

    yii2-fast-api

    开源软件地址:

    https://gitee.com/deepziyu/yii2-fast-api

    开源软件介绍:

    yii2-fast-api

    yii2-fast-api是一个Yii2框架的扩展,用于配置完善Yii2,以实现api的快速开发。此扩展默认的场景是APP的后端接口开发,因此偏向于实用主义,并未完全采用restfull的标准,方便前端开发处理接口数据以及各种异常。

    Installation

    使用 Composer 安装

    • 在项目中的 composer.json 文件中添加依赖:
    "require": {    "deepziyu/yii-fast-api": "*"}
    • 执行 $ php composer.phar update$ composer update 进行安装。

    • 在配置文件中( Yii2 高级版为 main.php,Yii2 基础版为 web.php )注入 fast-api 的配置:

    // $config 为你原本的配置$config = yii\helpers\ArrayHelper::merge(    $config,    \deepziyu\yii\rest\Controller::getConfig());return $config;

    Usage

    • 建立控制器
    class YourController extends deepziyu\yii\rest\Controller{    /**     * 示例接口     * @param int $id 请求参数     * @return string version api版本     * @return int yourId 你的请求参数     */    public function actionIndex($id)    {        return ['version'=>'1.0.0','yourId'=>$id];    }}
    • 发送请求看看

    正常请求

    POST /your/index HTTP/1.1Host: yoursite.comContent-Type: application/json{"id":"10"}

    返回

    {    "code": 200,    "data": {        "version": "1.0.0",        "yourId": "10"    },    "message": "OK"}

    缺少参数的请求

    POST /your/index HTTP/1.1Host: yoursite.comContent-Type: application/json

    返回错误

    {    "code": 400,    "data": {},    "message": "缺少参数:id"}
    • 查看自动生成的Api文档

    http ://yoursite.com/route/api/index

    mahua

    Words In The End

    感谢@暗夜在火星 的PhalApi项目,为此Yii2扩展提供设计的思路。

    TODO

    • 更完善的文档指南
    • Signature 过滤器插件
    • 限流插件的使用
    • RequestID 以及日志存储追踪的参考

    鲜花

    握手

    雷人

    路过

    鸡蛋
    该文章已有0人参与评论

    请发表评论

    全部评论

    专题导读
    热门推荐
    阅读排行榜

    扫描微信二维码

    查看手机版网站

    随时了解更新最新资讯

    139-2527-9053

    在线客服(服务时间 9:00~18:00)

    在线QQ客服
    地址:深圳市南山区西丽大学城创智工业园
    电邮:jeky_zhao#qq.com
    移动电话:139-2527-9053

    Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap