phalapi 2.14 使用(一)增加顶级命名空间、调整返回结构字段

一、增加顶级命名空间

Namespace是指命名空间中/Api/的前半部分。并且需要在根目录下的composer.json文件中进行autoload的注册,以便能正常自动加载类文件。如默认已经注册的App命名空间:

"psr-4" : {
            "App\\" : "src/app",
            "Portal\\" : "src/portal",
            "Foo\\" : "src/foo"
        }

配置好后,进行快捷更新,只更新命名空间的映射关系:

$ composer dumpautoload

此时,对于顶级命名空间Foo,其源代码保存在/path/to/phalapi/src/foo下。

需要注意的是,源代码目录需要自己手动添加,即分别添加以下几个常见目录:Api、Domain、Model、Common。以这里的Foo命名空间为例,需要创建以下目录:

src/foo/Api
src/foo/Domain
src/foo/Model
src/foo/Common

接下来就可以正常开始开发了。

二、调整返回的ret/data/msg结构字段

默认情况下,PhalApi接口框架在顶层的返回字段使用ret/data/msg结构,如果需要使用其他字段,可修改sys.response.structure_map映射配置,

打开./config/sys.php文件修改:

/**
     * 返回结果
     */
    'response' => array(
        'structure_map' => array( // 返回结构字段映射配置
            'ret'   => 'ret',
            'data'  => 'data',
            'msg'   => 'msg',
            'debug' => 'debug',
        ),
    ),

即可以把全部接口返回的结果字段进行映射调整,调整后接口返回示例是:

{
    "err_status": 200,
    "result": {
        "title": "Hello PhalApi",
        "version": "2.10.1",
        "time": 1582176767
    },
    "err_message": ""
}

 

posted @ 2020-06-30 15:23  世界因你而小  阅读(364)  评论(0编辑  收藏  举报