README

仓库弃用 2019-12-31

此仓库已迁移至 laminas-api-tools/api-tools-admin。

简介

zf-apigility-admin 模块提供了用于管理 Apigility 中 API 的后端管理 API 和前端 Admin UI。

注意

不要在生产系统中启用此模块。

需求

请参阅 composer.json 文件。

安装

运行以下 composer 命令

$ composer require --dev "zfcampus/zf-apigility-admin"

然后运行 composer install 确保模块已安装。

最后，将模块名称添加到项目 config/application.config.php 文件中的 modules 键下

return array(
    /* ... */
    'modules' => array(
        /* ... */
        'ZF\Apigility\Admin',
    ),
    /* ... */
);

通常，此模块应与 zf-development-mode 一起使用，以便有条件地在您的应用程序中启用模块。这样做时，您将添加模块到项目的 config/development.config.php.dist 文件而不是 config/application.config.php 文件，并通过 php public/index.php development enable 启用它。

升级

我们努力使升级过程尽可能简单，就像 composer update 一样；然而，有时可能需要其他步骤。本节记录了这些步骤。

首次升级到 1.5

如果您是从低于 1.5 版本的版本升级到 1.5 或更高版本，请注意以下更改。

首先，版本 1.5 放弃了对 rwoverdijk/assetmanager 的要求。然而，为了使用管理 UI，您需要一种方法来访问 UI 和 zf-apigility 模块提供的公共资产。您有三个选项

安装 rwoverdijk/assetmanager: composer require rwoverdijk/assetmanager。请注意，截至 1.5.0 版本发布时，此模块与 zend-mvc 的 v3 版本不兼容。如果您正在寻找快速升级，并且不关心安装的 Zend Framework 组件的版本，这是最简单的途径。
安装 zf-asset-manager。这是一个 Composer 插件，在安装或卸载包时运行。如果您添加此插件，您需要遵循以下步骤
- composer require --dev zfcampus/zf-asset-manager
- rm -Rf ./vendor
- composer install
这些额外步骤是必要的，以便插件能够获取来自其他组件的资产。
手动复制或创建符号链接到您公共目录中所需的资产。例如：
- ln -s vendor/zfcampus/zf-apigility/asset/zf-apigility public/zf-apigility
- ln -s vendor/zfcampus/zf-apigility-admin-ui/dist/apigility-ui public/apigility-ui

这三种方法都可以通过您的应用服务器使资产公开可用。

从1.5版本升级到v3 Zend Framework组件

在升级到此模块的1.5版本之后，您可以升级您的应用以利用Zend Framework v3组件。最简单的方法是使用提供的脚本

$ ./vendor/bin/apigility-upgrade-to-1.5

此脚本将更新您的Composer需求和建议，更新您的模块列表以列出ZF组件并删除不需要/过时的组件，然后重新安装所有依赖。

如果您不想使用脚本，或者脚本失败，您可以使用以下步骤手动更新您的应用

更新您的 composer.json
- 删除
  - require.zendframework/zendframework
  - require.rwoverdijk/assetmanager
  - require-dev.zendframework/zftool
- 更新
  - require.zfcampus/zf-development-mode约束变为^3.0
  - require-dev.zendframework/zend-developer-tools变为^1.0
- 添加
  - require.zendframework/zend-cache，约束为2.7.1
  - require.zendframework/zend-log，约束为2.9
  - require.zendframework/zend-mvc-i18n，约束为1.0
  - require-dev.zfcampus/zf-asset-manager，约束为^1.0
更新您的 config/modules.config.php
- 删除
  - AssetManager
  - ZF\DevelopmentMode
- 在列表顶部添加
  - Zend\Cache
  - Zend\Db
  - Zend\Filter
  - Zend\Hydrator
  - Zend\InputFilter
  - Zend\I18n
  - Zend\Log
  - Zend\Mvc\I18n
  - Zend\Paginator
  - Zend\Router
  - Zend\Validator
更新您的 config/development.config.php 和 config/development.config.php.dist 文件
- 从模块列表中删除
  - ZFTool
删除 composer.lock
递归删除 vendor/ 子目录
执行 composer install

开发模式

在1.5之前和运行升级脚本或遵循上述升级说明之前，Apigility使用zf-development-mode v2版本，这依赖于zend-mvc v2版本中默认存在的Console <-> MVC集成。

然而，zf-development-mode v3操作方式不同，它作为Composer供应商的二进制文件提供，没有额外的要求。调用现在是
$ ./vendor/bin/zf-development-mode enable
和
$ ./vendor/bin/zf-development-mode disable
您还可以查询状态
$ ./vendor/bin/zf-development-mode status

配置

由于此特定模块负责提供API和Apigility管理UI，它需要大量配置才能在开发环境中运行。由于开发者不太可能需要修改系统级配置，因此在此README中省略，但可以在存储库中找到。

此外，该模块在顶层键zf-apigility-admin下定义以下模块特定配置

键：path_spec

默认情况下，zf-apigility-admin将使用PSR-0目录结构创建新的Apigility模块。您可以使用zf-apigility-admin.path_spec配置切换到PSR-4，该配置接受以下值之一

ZF\Apigility\Admin\Model\ModulePathSpec::PSR_0 ('psr-0')
ZF\Apigility\Admin\Model\ModulePathSpec::PSR_4 ('psr-4')

路由

此模块公开HTTP可访问的API端点和静态资产。

API 端点

所有路由默认以 /apigility 前缀。

api/apigility-version

自 1.5.1 版本起

如果可以找到，则返回当前 Apigility 版本，否则返回字符串 @dev。有效负载在 version 键中

{
    "version": "1.4.0"
}

Accept: application/json
Content-Type: application/json
方法: GET
错误: 无

api/config

此端点用于检查应用程序配置，并提供其中单个值的覆盖。所有覆盖都写入单个文件 config/autoload/development.php；您可以通过 zf-configuration.config-file 键在配置中覆盖该位置。

Accept: application/json, application/vnd.zfcampus.v1.config+json

application/json 以平铺的键/值对数组的形式提供表示，键以点分隔，正如您在 INI 中找到的那样。

application/vnd.zfcampus.v1.config+json 以树的形式提供配置。
Content-Type: application/json, application/vnd.zfcampus.v1.config+json

application/json 表示您正在发送键/值对，键以点分隔的值，正如您在 INI 文件中找到的那样。

application/vnd.zfcampus.v1.config+json 表示您正在发送嵌套数组/对象配置。
方法: GET, PATCH
错误: application/problem+json

api/config/module?module={module name}

此操作与 api/config 端点完全相同，但期望一个已知的模块名称。当提供时，它允许您检查和操作该模块的配置文件。

api/authentication

此 REST 端点用于创建、更新和删除应用程序的认证配置。它使用认证资源。

Accept: application/json

在成功时返回认证资源。
Content-Type: application/json

期望一个认证资源，其中包含创建新或更新现有 HTTP 认证所需的所有详细信息。
HTTP 方法: GET, POST, PATCH, DELETE

GET 如果之前未设置任何认证，则返回 404 响应。POST 在成功时将返回 201 响应。PATCH 在成功时将返回 200 响应。DELETE 在成功时将返回 204 响应。
错误: application/problem+json

api/authentication[/:authentication_adapter] (API V2)

此 REST 端点用于获取和更新 Apigility 中使用的认证适配器。它使用认证资源 v2。

此端点仅适用于 API 版本 2。您需要在 Appect 标头中传递以下 mediatype

Accept: application/vnd.apigility.v2+json

Accept: application/json

在成功时返回认证资源 v2。
Content-Type: application/json

期望一个认证资源 v2，其中包含创建新或更新现有 HTTP 认证所需的所有详细信息。
HTTP 方法: GET, POST, PUT, DELETE

GET 请求如果没有之前设置过身份验证适配器，则返回 404 响应。POST 在成功时将返回 201 响应。PUT 在成功时将返回 200 响应。DELETE 在成功时将返回 204 响应。

api/module/:name/authentication?version=:version (API V2)

此 REST 端点用于获取和更新特定 API（模块）及其版本的身份验证映射（如果指定）。

此端点仅适用于 API 版本 2。您需要在 Appect 标头中传递以下 mediatype

Accept: application/vnd.apigility.v2+json

Accept: application/json

成功时返回一个 { "authentication" : value }。
Content-Type: application/json

期望一个包含 authentication 值的 JSON，该值包含身份验证适配器名称。
HTTP 方法：GET、PUT、DELETE

GET 将返回一个 { "authentication" : value } 响应。如果没有身份验证适配器存在，则值将为 false。

PATCH 在成功时将返回 200 响应，并带有更新的身份验证值。

DELETE 在成功时将返回 204 响应。

api/module/:name/authorization?version=:version

此 REST 端点用于获取和更新应用程序的授权配置。它使用授权资源。

Accept: application/json

成功时返回授权资源。
Content-Type: application/json

期望一个授权资源，其中包含指定授权规则所需的所有详细信息。
HTTP 方法：GET、PATCH

GET 总是返回一个实体；如果模块之前没有配置，或者如果指定版本中的任何给定服务未列在配置中，它将提供默认值。

PATCH 在成功时将返回 200 响应，并带有更新的实体。
错误: application/problem+json

api/db-adapter[/:adapter_name]

此 REST 端点用于创建、更新和删除命名的 Zend\Db 适配器；它使用 db-adapter 资源。

Accept: application/json

成功时返回一个 db-adapter 资源。
Content-Type: application/json

期望 db-adapter 资源，其中包含创建或更新数据库连接所需的所有详细信息。
集合方法：GET、POST
资源方法：GET、PATCH、DELETE
错误: application/problem+json

api/module.enable

此端点将为现有的模块启用 Apigility（Apigilify？）。

Accept: application/json

成功时返回一个模块资源。
Content-Type: application/json

期望一个对象，其中包含 "module" 属性，描述一个现有的 ZF2 模块。
方法：PUT
错误: application/problem+json

请求负载应具有以下结构

{
    "module": "Status"
}

api/validators

此端点提供了一个已注册验证插件列表的排序列表；用例是在创建服务输入过滤器时构建可用插件的下拉列表。ZF2 ValidatorPluginManager 服务中存在的任何验证器都将表示。

Accept: application/json

成功时返回一个 application/json 响应。
方法: GET
错误: application/problem+json

成功请求的响应负载具有以下格式

{
  "validators": [
    "list",
    "of",
    "validators"
  ]
}

api/versioning

此端点用于向现有 API 添加新版本。如果在负载中未传递版本，则版本号将简单递增。

Accept: application/json

成功时返回一个 JSON 结构，错误时返回 API-Problem 负载。
Content-Type: application/json

期望对象包含“module”属性，提供ZF2、Apigility启用模块的名称；可选地，也可以提供一个“version”属性来指示要使用的特定版本字符串。
方法： PATCH
错误: application/problem+json

请求负载应具有以下结构

{
    "module": "Status",
    "version": 10
}

成功时，服务返回以下结构

{
    "success": true,
    "version": "version string or integer"
}

api/module[/:name]

这是模块资源的规范端点。

Accept: application/json

成功时，返回单个模块资源（当提供name时）或一组模块资源（当未提供name时）。
Content-Type: application/json

期望一个对象，该对象包含描述要创建的模块的“name”属性。
集合方法：GET、POST
资源方法：GET
错误: application/problem+json

在创建新的API模块时，使用以下请求负载

{
    "name": "Status"
}

api/module/:name/rpc[/:controller_service_name]

这是RPC资源的规范端点。

Accept: application/json

成功时，返回单个RPC资源（当提供controller_service_name时）或一组RPC资源（当未提供controller_service_name时）。
Content-Type: application/json

期望一个对象，该对象包含描述要创建的端点的“service_name”属性。

您还可以提供RPC资源中列出的任何其他选项。
集合方法：GET、POST
资源方法：GET，PATCH
可以将查询字符串变量version传递给集合以按版本过滤结果：例如，/admin/api/module/:name/rpc?version=2。
错误: application/problem+json

所需的最小请求负载结构如下

{
    "service_name": "Status"
}

api/module/:name/rpc/:controller_service_name/inputfilter[/:input_filter_name]

此服务用于创建、更新和删除与给定RPC服务关联的命名输入过滤器。

Accept: application/json

成功时，返回单个输入过滤器（当提供input_filter_name时）或一组输入过滤器（当未提供input_filter_name时）。通常，只有一个输入过滤器将与给定的RPC服务相关联。

返回的输入过滤器还将组成一个属性input_filter_name，它是给定输入过滤器的标识符。
Content-Type: application/json

期望一个输入过滤器。
集合方法：GET、POST
资源方法：GET，PUT，DELETE
错误: application/problem+json

api/module/:name/rest[/:controller_service_name]

这是REST资源的规范端点。

可用于任何类型的REST资源，包括DB-Connected。

DB-Connected资源期望以下附加属性（并且将返回它们）

adapter_name：一个命名DB适配器服务。
table_name：与此服务关联的数据库表。
hydrator_name：可选；这是用于填充数据库返回的行的hydrator服务的名称；默认为ArraySerializable。
table_service：可选；默认情况下这是自动生成的，但可以提供替代的TableGateway服务。
Accept: application/json

成功时，返回单个REST资源（当提供controller_service_name时）或一组REST资源（当未提供controller_service_name时）。
Content-Type: application/json

期望一个对象，该对象包含描述要创建的REST服务的resource_name属性。

您还可以提供在REST资源中列出的任何其他选项。
收集方法： GET，POST，DELETE
资源方法：GET，PATCH
查询字符串变量version可以传递给收集，以通过版本过滤结果：例如，/admin/api/module/:name/rest?version=2。
错误: application/problem+json

创建新REST服务的基本结构如下

{
    "resource_name": "Status"
}

api/package

此端点用于构建API的部署包。

Accept: application/json

成功时返回一个 JSON 结构，错误时返回 API-Problem 负载。
Content-Type: application/json

期望一个对象，包含“format”属性，用于文件格式ZIP，TAR，TGZ和ZPK；一个“apis”属性，其中包含要包含在包中的API列表；一个“composer”属性，指定是否执行composer，以及一个可选的“config”属性，包含要在包中使用的应用程序配置文件夹的路径。
方法： GET，POST
错误: application/problem+json

POST请求的有效负载应该具有以下结构

{
    "format": "the file format to be used for the package",
    "apis" : {
        "Test": true
    },
    "composer": true,
    "config": "the config path to be used in the package"
}

成功时，服务返回以下结构

{
    "token": "a random token string",
    "format": "the file format used for the package"
}

此响应字段可以在GET方法中使用以下载包文件。基本上，令牌是存储在系统临时文件夹中的临时文件名（在GNU/Linux中为/tmp）。

GET请求的有效负载应该具有以下结构

GET /api/package?token=xxx&format=yyy

成功时，服务将以application/octet-stream内容类型返回文件。

API模型

以下是一份各种模型的列表，这些模型可以通过上述API端点返回，或者是在请求体中预期的。

认证

HTTP基本认证

{
    "accept_schemes": [ "basic" ],
    "realm": "The HTTP authentication realm to use",
    "htpasswd": "path on filesystem to htpasswd file"
}

HTTP摘要认证

{
    "accept_schemes": [ "digest" ],
    "realm": "The HTTP authentication realm to use",
    "htdigest": "path on filesystem to htdigest file",
    "nonce_timeout": "integer; seconds",
    "digest_domains": "Space-separated list of URIs under authentication"
}

OAuth2认证

{
    "dsn": "PDO DSN of database containing OAuth2 schema",
    "username": "Username associated with DSN",
    "password": "Password associated with DSN",
    "route_match": "Literal route to match indicating where OAuth2 login/authorization exists"
}

认证2

HTTP基本认证

{
    "name" : "Name of the authentication adapter",
    "type": "basic",
    "realm": "The HTTP authentication realm to use",
    "htpasswd": "Path on filesystem to htpasswd file"
}

HTTP摘要认证

{
    "name" : "Name of the authentication adapter",
    "type": "digest",
    "realm": "The HTTP authentication realm to use",
    "digest_domains": "Space-separated list of URIs under authentication",
    "nonce_timeout": "integer; seconds",
    "htdigest": "Path on filesystem to htdigest file"
}

OAuth2认证（使用PDO）

{
    "name" : "Name of the authentication adapter",
    "type": "oauth2",
    "oauth2_type" : "pdo",
    "oauth2_route" : "Literal route to match indicating where OAuth2 login/authorization exists",
    "oauth2_dsn": "PDO DSN of database containing OAuth2 schema",
    "oauth2_username": "Username associated with DSN (optional)",
    "oauth2_password": "Password associated with DSN (optional)",
    "oauth2_options": "(optional)"
}

OAuth2认证（使用MongoDB）

{
    "name" : "Name of the authentication adapter",
    "type": "oauth2",
    "oauth2_type" : "mongo",
    "oauth2_route" : "Literal route to match indicating where OAuth2 login/authorization exists",
    "oauth2_dsn": "MongoDB DSN of database containing OAuth2 documents",
    "oauth2_database": "Database name",
    "oauth2_locator_name": "SomeServiceName class (optional)",
    "oauth2_options": "(optional)"
}

授权

{
    "Rest\Controller\Service\Name::__resource__": {
        "GET": bool,
        "POST": bool,
        "PUT": bool,
        "PATCH": bool,
        "DELETE": bool
    },
    "Rest\Controller\Service\Name::__collection__": {
        "GET": bool,
        "POST": bool,
        "PUT": bool,
        "PATCH": bool,
        "DELETE": bool
    },
    "Rpc\Controller\Service\Name::actionName": {
        "GET": bool,
        "POST": bool,
        "PUT": bool,
        "PATCH": bool,
        "DELETE": bool
    }
}

REST服务为其实体的每个实例和收集实例都有一个条目。RPC服务为每个公开的动作名称有一个条目（这通常只有一个）。每个服务都有一个包含标志的HTTP方法列表。false值表示不需要授权；true值表示需要授权。

注意：如果将deny_by_default标志设置在应用程序中，则标志的意义相反；true表示方法是公开的，false表示需要认证。

db-adapter

{
    "adapter_name": "Service name for the DB adapter",
    "database": "Name of the database",
    "driver": "Driver used to make the connection"
}

此外，还可以组合用于创建Zend\Db\Adapter\Adapter实例的任何其他属性，例如“username”，“password”等。

inputfilter

{
    "input_name": {
        "name": "name of the input; should match key of object",
        "validators": [
            {
                "name": "Name of validator service",
                "options": {
                    "key": "value pairs to specify behavior of validator"
                }
            }
        ]
    }
}

输入过滤器可以包含任意数量的输入，其格式遵循[Zend Framework 2 输入过滤器文档]中描述的Zend\InputFilter\Factory格式（http://framework.zend.com/manual/2.3/zh-cn/modules/zend.input-filter.intro.html）。

目前，我们不允许嵌套输入过滤器。

模块

{
    "name": "normalized module name",
    "namespace": "PHP namespace of the module",
    "is_vendor": "boolean value indicating whether or not this is a vendor (3rd party) module",
    "versions": [
        "Array",
        "of",
        "available versions"
    ]
}

此外，module资源为RPC和REST资源组成关系链接；这些分别使用关系“rpc”和“rest”。

rpc

{
    "controller_service_name": "name of the controller service; this is the identifier, and required",
    "accept_whitelist": [
        "(Optional)",
        "List",
        "of",
        "whitelisted",
        "Accept",
        "mediatypes"
    ],
    "content_type_whitelist": [
        "(Optional)",
        "List",
        "of",
        "whitelisted",
        "Content-Type",
        "mediatypes"
    ],
    "http_options": [
        "(Required)",
        "List",
        "of",
        "allowed",
        "Request methods"
    ],
    "input_filter": "(Optional) Present in returned RPC services, when one or more input filters are present; see the inputfilter resource for details",
    "route_match": "(Required) String indicating Segment route to match",
    "route_name": "(Only in representation) Name of route associated with endpoint",
    "selector": "(Optional) Content-Negotiation selector to use; Json by default"
}

rest

{
    "controller_service_name": "name of the controller service; this is the identifier, and required",
    "accept_whitelist": [
        "(Optional)",
        "List",
        "of",
        "whitelisted",
        "Accept",
        "mediatypes"
    ],
    "adapter_name": "(Only in DB-Connected resources) Name of Zend\\DB adapter service used for this resource",
    "collection_class": "(Only in representation) Name of class representing collection",
    "collection_http_options": [
        "(Required)",
        "List",
        "of",
        "allowed",
        "Request methods",
        "on collections"
    ],
    "collection_query_whitelist": [
        "(Optional)",
        "List",
        "of",
        "whitelisted",
        "query string parameters",
        "to pass to resource for collections"
    ],
    "content_type_whitelist": [
        "(Optional)",
        "List",
        "of",
        "whitelisted",
        "Content-Type",
        "mediatypes"
    ],
    "entity_class": "(Only in representation) Name of class representing resource entity",
    "entity_identifier_name": "(Optional) Name of entity field representing the identifier; defaults to 'id'",
    "hydrator_name": "(Only in DB-Connected resources) Name of Zend\\Stdlib\\Hydrator service used for this resource",
    "route_identifier_name": "(Optional) Name of route parameter representing the resource identifier; defaults to resource_name + _id",
    "input_filter": "(Optional) Present in returned REST services, when one or more input filters are present; see the inputfilter resource for details",
    "module": "(Only in representation) Name of module in which resource resides",
    "page_size": "(Optional) Integer representing number of entities to return in a given page in a collection; defaults to 25",
    "page_size_param": "(Optional) Name of query string parameter used for pagination; defaults to 'page'",
    "resource_class": "(Only in representation) Name of class representing resource handling operations",
    "resource_http_options": [
        "(Required)",
        "List",
        "of",
        "allowed",
        "Request methods",
        "on individual resources"
    ],
    "route_match": "(Optional) String indicating Segment route to match; defaults to /resource_name[/:route_identifier_name]",
    "route_name": "(Only in representation) Name of route associated with api service",
    "selector": "(Optional) Content-Negotiation selector to use; HalJson by default",
    "table_name": "(Only in DB-Connected resources) Name of database table used for this resource",
    "table_service": "(Only in DB-Connected resources) Name of TableGateway service used for this resource"
}

ZF2 事件

监听器

ZF\Apigility\Admin\Module

该监听器附加到MvcEvent::EVENT_RENDER，优先级为100。它负责根据控制器服务结果是否为实体或集合条件性地附加监听器。如果检测到其中任何一个，监听器将附加到ZF\Hal\Plugin\Hal事件的renderEntity和renderCollection.entity，确保它们在HAL插件有机会开始渲染时被触发。

ZF2 服务

模型

许多由zf-apigility-admin提供的模型服务要么处理PHP代码的生成和修改，要么处理基于PHP的配置文件的生成和修改。

ZF\Apigility\Admin\Model\AuthenticationModel - 负责创建和修改HTTP Basic、HTTP Digest和OAuth2策略的特定认证配置。敏感信息将写入本地配置文件，而结构信息将写入全局和模块文件。
ZF\Apigility\Admin\Model\AuthorizationModelFactory - 负责将授权特定细节（允许/拒绝规则的ACL矩阵）写入模块配置文件。
ZF\Apigility\Admin\Model\ContentNegotiationModel - 负责将自定义内容协商选择器写入全局配置文件。
ZF\Apigility\Admin\Model\ContentNegotiationResource - 消耗ContentNegotiationModel的REST资源，以便公开内容协商配置管理的API端点。
ZF\Apigility\Admin\Model\DbAdapterModel - 负责在应用程序级别的全局和本地配置文件之间写入特定数据库适配器的配置。敏感信息将写入本地配置文件。
ZF\Apigility\Admin\Model\DbAdapterResource - 消耗DbAdapterModel的REST资源，以便公开数据库适配器配置管理的API端点。
ZF\Apigility\Admin\Model\DbConnectedRestServiceModel - 负责写入将数据库表公开为REST资源所需的所有配置信息。
ZF\Apigility\Admin\Model\DocumentationModel - 负责在模块配置目录中写入一个特殊命名的文件，该文件将包含所有自定义API文档，包括请求、响应以及API的所有其他可记录元素。
ZF\Apigility\Admin\Model\InputFilterModel - 负责为每个模块编写输入过滤器规范配置。
ZF\Apigility\Admin\Model\FiltersModel - 负责通过API提供内置过滤器及其元数据的列表。
ZF\Apigility\Admin\Model\HydratorsModel - 负责配置和管理全局hydrator服务名称列表。
ZF\Apigility\Admin\Model\ModuleModel - 负责聚合模块信息，包括REST和RPC服务，并通过API公开这些信息。此外，当创建新模块时，它将创建启用Apigility模块所需的代码工件。
ZF\Apigility\Admin\Model\ModuleResource - 负责在Apigility API中将ModuleModel公开为REST资源。
ZF\Apigility\Admin\Model\RestServiceModel - 负责以可在Admin UI中创建和修改的方式呈现REST服务，正如它们在zf-rest中定义的那样。
ZF\Apigility\Admin\Model\RestServiceResource - 负责消费RestServiceModel并将该模型作为Apigility API中的REST资源公开。
ZF\Apigility\Admin\Model\RestServiceModelFactory - 负责创建RestServiceModel。
ZF\Apigility\Admin\Model\RpcServiceModel - 负责以可在Admin UI中创建和修改的方式呈现RPC服务，正如它们在zf-rpc中定义的那样。
ZF\Apigility\Admin\Model\RpcServiceResource - 负责消费RpcServiceModel并将该模型作为Apigility API中的REST资源公开。
ZF\Apigility\Admin\Model\RpcServiceModelFactory - 负责创建RpcServiceModel。
ZF\Apigility\Admin\Model\ValidatorsModel - 通过API提供一组可用的验证器列表。
ZF\Apigility\Admin\Model\ValidatorMetadataModel - 负责提供关于通过ValidatorModel和验证器API提供的验证器的元数据。
ZF\Apigility\Admin\Model\VersioningModel - 负责对提供特定基于Apigility的REST或RPC服务的新版本的流程和模块代码创建工件进行建模。
ZF\Apigility\Admin\Model\ModuleVersioningModelFactory - 负责创建ModuleVersioningModel。

zfcampus / zf-apigility-admin

维护者

详细信息

README

仓库弃用 2019-12-31

简介

注意

需求

安装

升级

首次升级到 1.5

从1.5版本升级到v3 Zend Framework组件

开发模式

配置

键：path_spec

路由

API 端点

api/apigility-version

api/config

api/config/module?module={module name}

api/authentication

api/authentication[/:authentication_adapter] (API V2)

api/module/:name/authentication?version=:version (API V2)

api/module/:name/authorization?version=:version

api/db-adapter[/:adapter_name]

api/module.enable

api/validators

api/versioning

api/module[/:name]

api/module/:name/rpc[/:controller_service_name]

api/module/:name/rpc/:controller_service_name/inputfilter[/:input_filter_name]

api/module/:name/rest[/:controller_service_name]

api/package

API模型

认证

HTTP基本认证

HTTP摘要认证

OAuth2认证

认证2

HTTP基本认证

HTTP摘要认证

OAuth2认证（使用PDO）

OAuth2认证（使用MongoDB）

授权

db-adapter

inputfilter

模块

rpc

rest

ZF2 事件

监听器

ZF\Apigility\Admin\Module

ZF2 服务

模型