donglun4682 2018-03-23 11:30
浏览 82
已采纳

CodeIgniter 3 - 支持控制器中的API和Web请求?

I'm currently working with a CodeIgniter3 application, and have built the basis for a standard blog-like system.

The structure is standard CI - User requests a page, page loads controller method, controller method calls any relevant DB functions from its model, and then a view is loaded.

However, I'm looking to also make this view accessible via an API. So, instead of the $data array being filled with information to populate into HTML, I would instead pass it to a different view which would output a JSON result.

I imagine writing two different controllers would be a bad step to take - is there any routing I can do, or any standard practice to allow for the controllers to recognise an api endpoint has been hit (such as the directory 'api' being in the access path), and then load up a different view based on this?

  • 写回答

1条回答 默认 最新

  • dongying195959 2018-03-23 13:17
    关注

    For an API, I wouldn't use a view. Views are traditionally for HTML. I'd suggest instead of passing $data to a view, simply echo it out at the end of the controller like so.

    echo json_encode($data);
    

    I've created this wrapper to make extending how I return data flexible. Here's a basic example.

    function api_response($data = array()) {
        $data['error'] = false;
        function filter(&$value) {
            if (is_string($value)) {
                $value = htmlspecialchars($value, ENT_QUOTES, 'UTF-8');
                $value = nl2br($value);
            }
        }
        array_walk_recursive($data, "filter");
        return json_encode($data);
    }
    

    And I use something like this for API errors

    function api_error_response($error_code, $error_message) {
        log_message('error', $error_code . ' - ' . $error_message);
        $data['error'] = true;
        $data['error_code'] = $error_code;
        $data['error_message'] = $error_message;
        return json_encode($data);
    }
    

    And then I call it like so at the end of a controller.

    echo api_response($data);
    

    Additionally, to be able to use the same controller methods for the API as you do for the web GUI, only duplicate the routes, and in the controller methods use something like this.

    // Return here for API
    if (strpos($_SERVER['REQUEST_URI'], '/api/') !== false) {
        // Unset any data you don't want through the API
        unset($data['user']);
        echo api_response($data);
        return false;
    }
    // Else, load views here
    
    本回答被题主选为最佳回答 , 对您是否有帮助呢?
    评论

报告相同问题?

悬赏问题

  • ¥15 如何用MATLAB实现以下三个公式(有相互嵌套)
  • ¥50 安装华大九天aether
  • ¥30 关于#算法#的问题:运用EViews第九版本进行一系列计量经济学的时间数列数据回归分析预测问题 求各位帮我解答一下
  • ¥15 setInterval 页面闪烁,怎么解决
  • ¥15 如何让企业微信机器人实现消息汇总整合
  • ¥50 关于#ui#的问题:做yolov8的ui界面出现的问题
  • ¥15 如何用Python爬取各高校教师公开的教育和工作经历
  • ¥15 TLE9879QXA40 电机驱动
  • ¥20 对于工程问题的非线性数学模型进行线性化
  • ¥15 Mirare PLUS 进行密钥认证?(详解)