创建 Restful API 在响应之前应该放置什么样的标头

Question

我没有找到很多关于这方面的信息，也许我只是搜索错了，谁知道呢。我想知道或尝试弄清楚的是我应该为 API 响应示例输出什么样的标头

header('Content-Type: application/json');

是我会为数据类型发布的东西，但是否有其他时间、到期或其他我应该关注的事情？

最终，我正在尝试为我想要开发的应用程序制作一个 API，所以我试图尽早弄清楚什么是跨平台兼容的以及需求是什么，这样我就可以尝试将它们构建到我的想法中，这将是标准开发的一部分

Answer 1

现在这就是你想要的。

主文件：Rest.inc.php

<?php
    class REST {
        public $_allow = array();
        public $_content_type = "application/json";
        public $_request = array();
        private $_method = "";        
        private $_code = 200;
        public function __construct(){
            $this->inputs();
        }
        public function get_referer(){
            return $_SERVER['HTTP_REFERER'];
        }
        public function response($data,$status){
            $this->_code = ($status)?$status:200;
            $this->set_headers();
            echo $data;
            exit;
        }
        private function get_status_message(){
            $status = array(
                        100 => 'Continue',  
                        101 => 'Switching Protocols',  
                        200 => 'OK',
                        201 => 'Created',  
                        202 => 'Accepted',  
                        203 => 'Non-Authoritative Information',  
                        204 => 'No Content',  
                        205 => 'Reset Content',  
                        206 => 'Partial Content',  
                        300 => 'Multiple Choices',  
                        301 => 'Moved Permanently',  
                        302 => 'Found',  
                        303 => 'See Other',  
                        304 => 'Not Modified',  
                        305 => 'Use Proxy',  
                        306 => '(Unused)',  
                        307 => 'Temporary Redirect',  
                        400 => 'Bad Request',  
                        401 => 'Unauthorized',  
                        402 => 'Payment Required',  
                        403 => 'Forbidden',  
                        404 => 'Not Found',  
                        405 => 'Method Not Allowed',  
                        406 => 'Not Acceptable',  
                        407 => 'Proxy Authentication Required',  
                        408 => 'Request Timeout',  
                        409 => 'Conflict',  
                        410 => 'Gone',  
                        411 => 'Length Required',  
                        412 => 'Precondition Failed',  
                        413 => 'Request Entity Too Large',  
                        414 => 'Request-URI Too Long',  
                        415 => 'Unsupported Media Type',  
                        416 => 'Requested Range Not Satisfiable',  
                        417 => 'Expectation Failed',  
                        500 => 'Internal Server Error',  
                        501 => 'Not Implemented',  
                        502 => 'Bad Gateway',  
                        503 => 'Service Unavailable',  
                        504 => 'Gateway Timeout',  
                        505 => 'HTTP Version Not Supported');
            return ($status[$this->_code])?$status[$this->_code]:$status[500];
        }
        public function get_request_method(){
            return $_SERVER['REQUEST_METHOD'];
        }
        private function inputs(){
            switch($this->get_request_method()){
                case "POST":
                    $this->_request = $this->cleanInputs($_POST);
                    break;
                case "GET":
                    //break;
                case "DELETE":
                    $this->_request = $this->cleanInputs($_GET);
                    break;
                case "PUT":
                    parse_str(file_get_contents("php://input"),$this->_request);
                    $this->_request = $this->cleanInputs($this->_request);
                    break;
                default:
                    $this->response('',406);
                    break;
            }
        }        
        private function cleanInputs($data){
            $clean_input = array();
            if(is_array($data)){
                foreach($data as $k => $v){
                    $clean_input[$k] = $this->cleanInputs($v);
                }
            }else{
                if(get_magic_quotes_gpc()){
                    $data = trim(stripslashes($data));
                }
                $data = strip_tags($data);
                $clean_input = trim($data);
            }
            return $clean_input;
        }        
        private function set_headers(){
            header("HTTP/1.1 ".$this->_code." ".$this->get_status_message());
            header("Content-Type:".$this->_content_type);
        }
    }    
?>

文件api.php中的 API 函数

<?php
    error_reporting(E_ALL ^ E_DEPRECATED);
    require_once("Rest.inc.php");
    class API extends REST {
        public $data = "";
        const DB_SERVER = "host";
        const DB_USER = "username";
        const DB_PASSWORD = "asdfgf";
        const DB = "database name";
        private $db = NULL;
        public function __construct(){
            parent::__construct();                // Init parent contructor
            $this->dbConnect();                    // Initiate Database connection
        }
        /*
           Database connection 
        */
        private function dbConnect(){
            $this->db = mysql_pconnect(self::DB_SERVER,self::DB_USER,self::DB_PASSWORD);
            if (!$this->db)
            {
              echo "Please try later.";
            }
            if($this->db)
                mysql_select_db(self::DB,$this->db);
        }
        /*
         * Public method for access api.
         * This method dynmically call the method based on the query string
         *
         */
        public function processApi(){
            $func = strtolower(trim(str_replace("/","",$_REQUEST['rquest'])));
            if((int)method_exists($this,$func) > 0)
                $this->$func();
            else
                $this->response('',400);                // If the method not exist with in this class, response would be "Page not found".
        }
        /*************API SPACE START*******************/
        private function about(){
            if($this->get_request_method() != "POST"){
                $error = array('status' => 'WRONG_CALL', "msg" => "The type of call cannot be accepted by our servers.");
                $error = $this->json($error);
                $this->response($error,406);
            }
            $data = array('version' => '0.1', 'desc' => 'This API is created by Blovia Technologies Pvt. Ltd., for the public usage for accessing data about vehicles.');
            $data = $this->json($data);
            $this->response($data,200);
        }

        /*************API SPACE END*********************/
        /*
            Encode array into JSON
        */
        private function json($data){
            if(is_array($data)){
                return json_encode($data, JSON_PRETTY_PRINT);
            }
        }
    }
    // Initiiate Library
    $api = new API;
    $api->processApi();
?>

现在终于配置.htaccess

在放置api.php和Rest.inc.php的同一文件夹中创建名为 .htaccess

的文件

RewriteBase /
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-s
RewriteRule ^(.*)$ api.php?rquest=$1 [QSA,NC,L]
RewriteCond %{REQUEST_FILENAME} -d
RewriteRule ^(.*)$ api.php [QSA,NC,L]
RewriteCond %{REQUEST_FILENAME} -s
RewriteRule ^(.*)$ api.php [QSA,NC,L]   

现在像这样调用你的 API

localhost/about

其中 about 是函数。您可以在函数内部动态检查它是 GET 还是 POST，并根据需要发送响应文本和代码。我已经完全给了你想要的。

考虑到api.php和Rest.inc.php都在/中，（这就是.htaccess文件中RewriteBase的内容）

如果要将文件放在其他目录或文件夹中，例如/beta/v1/

将RewriteBase从/更改为/beta/v1

注意。将 .htaccess 放在同一个文件夹中。

并且两个文件都在同一个目录中。该目录应放置在 htaccess 中 RewriteBase

如果您在理解上述内容时遇到任何问题，请告诉我。

Answer 2

我在响应标头中包含的一件好事是发送的请求的相关 ID。 这允许 API 的使用者将问题或潜在错误与请求相关联，并允许您查找与该请求相关的信息。

当然，这需要您记录与相关 id 相关的信息，但事实证明它对我非常有用。