mardraze/zf-apigility-admin

Apigility Admin module

Apigility Admin

, _(*1)

Introduction

The zf-apigility-admin module delivers the backend management API and frontend Admin UI used to manage APIs in Apigility., _(*2)

NOTE

DO NOT enable this module in production systems., _(*3)

Requirements

Please see the composer.json file., _(*4)

Installation

Run the following composer command:, _(*5)

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

And then run composer install to ensure the module is installed., _(*6)

Finally, add the module name to your project's config/application.config.php under the modules key:, _(*7)

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

Typically, this module should be used along with zf-development-mode in order to conditionally enable the module in your application. When doing so, you will add the module to your project's config/development.config.php.dist file instead of the config/application.config.php file, and enable it via php public/index.php development enable., _(*8)

Configuration

There is no custom user level configuration for this module., _(*9)

Since this particular module is responsible for providing APIs and the Apigility Admin UI, it has a significant amount of configuration that it requires in order to function in a development environment. Since it is highly unlikely that developers would need to modify the system-level configuration, it is omitted in this README, but can be found within the repository., _(*10)

Routes

This module exposes HTTP accessible API endpoints and static assets., _(*11)

API Endpoints

All routes are prefixed with /apigility by default., _(*12)

api/config

This endpoint is for examining the application configuration, and providing overrides of individual values in it. All overrides are written to a single file, config/autoload/development.php; you can override that location in your configuration via the zf-configuration.config-file key., _(*13)

• Accept: application/json, application/vnd.zfcampus.v1.config+json, _(*14)

  application/json will deliver representations as a flat array of key/value pairs, with the keys being dot-separated values, just as you would find in INI., _(*15)

  application/vnd.zfcampus.v1.config+json will deliver the configuration as a tree., _(*16)

• Content-Type: application/json, application/vnd.zfcampus.v1.config+json, _(*17)

  application/json indicates you are sending key/value pairs, with keys being dot-separated values, as you would find in INI files., _(*18)

  application/vnd.zfcampus.v1.config+json indicates you are sending a nested array/object of configuration., _(*19)

• Methods: GET, PATCH, _(*20)

• Errors: application/problem+json, _(*21)

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

This operates exactly like the api/config endpoint, but expects a known module name. When provided, it allows you to introspect and manipulate the configuration file for that module., _(*22)

api/authentication

This REST endpoint is for creating, updating, and deleting the authentication configuration for your application. It uses the authentication resource., _(*23)

• Accept: application/json, _(*24)

  Returns an authentication resource on success., _(*25)

• Content-Type: application/json, _(*26)

  Expects an authentication resource with all details necessary for creating new, or updating existing, HTTP authentication., _(*27)

• HTTP methods: GET, POST, PATCH, DELETE, _(*28)

  GET returns a 404 response if no authentication has previously been setup. POST will return a 201 response on success. PATCH will return a 200 response on success. DELETE will return a 204 response on success., _(*29)

• Errors: application/problem+json, _(*30)

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

This REST endpoint is for fetching and updating the authentication adapters to be used in Apigility. It uses the authentication resource ver. 2., _(*31)

This endpoint is only available for API version 2. You need to pass the following mediatype in the Appect header:, _(*32)

Accept: application/vnd.apigility.v2+json

• Accept: application/json, _(*33)

  Returns an authentication resource ver. 2 on success., _(*34)

• Content-Type: application/json, _(*35)

  Expects an authentication resource ver. 2 with all details necessary for creating new, or updating existing, HTTP authentication., _(*36)

• HTTP methods: GET, POST, PUT, DELETE, _(*37)

  GET returns a 404 response if no authentication adapter has previously been setup. POST will return a 201 response on success. PUT will return a 200 response on success. DELETE will return a 204 response on success., _(*38)

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

This REST endpoint is for fetching and updating the authentication mapping for a specific API (module) and version, if specified., _(*39)

This endpoint is only available for API version 2. You need to pass the following mediatype in the Appect header:, _(*40)

Accept: application/vnd.apigility.v2+json

• Accept: application/json, _(*41)

  Returns an { "authentication" : value } on success., _(*42)

• Content-Type: application/json, _(*43)

  Expects a JSON with authentication value containing the authentication adapter name., _(*44)

• HTTP methods: GET, PUT, DELETE, _(*45)

  GET will return an { "authentication" : value } response. If no authentication adapter exists the value will be false., _(*46)

  PATCH will return a 200 response on success, along with the updated authentication value., _(*47)

  DELETE will return a 204 response on success., _(*48)

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

This REST endpoint is for fetching and updating the authorization configuration for your application. It uses the authorization resource., _(*49)

• Accept: application/json, _(*50)

  Returns an authorization resource on success., _(*51)

• Content-Type: application/json, _(*52)

  Expects an authorization resource with all details necessary for specifying authorization rules., _(*53)

• HTTP methods: GET, PATCH, _(*54)

  GET will always return an entity; if no configuration existed previously for the module, or if any given service at the given version was not listed in the configuration, it will provide the default values., _(*55)

  PATCH will return a 200 response on success, along with the updated entity., _(*56)

• Errors: application/problem+json, _(*57)

api/db-adapter[/:adapter_name]

This REST endpoint is for creating, updating, and deleting named Zend\Db adapters; it uses the db-adapter resource., _(*58)

• Accept: application/json, _(*59)

  Returns a db-adapter resource on success., _(*60)

• Content-Type: application/json, _(*61)

  Expects db-adapter resource with all details necessary for creating or updating a DB connection., _(*62)

• Collection Methods: GET, POST, _(*63)

• Resource Methods: GET, PATCH, DELETE, _(*64)

• Errors: application/problem+json, _(*65)

api/module.enable

This endpoint will Apigility-enable (Apigilify?) an existing module., _(*66)

• Accept: application/json, _(*67)

  Returns a Module resource on success., _(*68)

• Content-Type: application/json, _(*69)

  Expects an object with the property "module" describing an existing ZF2 module., _(*70)

• Methods: PUT, _(*71)

• Errors: application/problem+json, _(*72)

The request payload should hav ethe following structure:, _(*73)

{
    "module": "Status"
}

api/validators

This endpoint provides a sorted list of all registered validator plugins; the use case is for building a drop-down of available plugins when creating an input filter for a service. Any validator present in the ZF2 ValidatorPluginManager service will be represented., _(*74)

• Accept: application/json, _(*75)

  Returns an application/json response on success., _(*76)

• Methods: GET, _(*77)

• Errors: application/problem+json, _(*78)

The response payload for a successful request has the following format:, _(*79)

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

api/versioning

This endpoint is for adding a new version to an existing API. If no version is passed in the payload, the version number is simply incremented., _(*80)

• Accept: application/json, _(*81)

  Returns a JSON structure on success, an API-Problem payload on error., _(*82)

• Content-Type: application/json, _(*83)

  Expects an object with the property "module", providing the name of a ZF2, Apigility-enabled module; optionally, a "version" property may also be provided to indicate the specific version string to use., _(*84)

• Methods: PATCH, _(*85)

• Errors: application/problem+json, _(*86)

The request payload should have the following structure:, _(*87)

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

On success, the service returns the followings structure:, _(*88)

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

api/module[/:name]

This is the canonical endpoint for Module resources., _(*89)

• Accept: application/json, _(*90)

  Returns either a single Module resource (when a name is provided) or a collection of Module resources (when no name is provided) on success., _(*91)

• Content-Type: application/json, _(*92)

  Expects an object with the property "name" describing the module to create., _(*93)

• Collection Methods: GET, POST, _(*94)

• Resource Methods: GET, _(*95)

• Errors: application/problem+json, _(*96)

When creating a new API module, use the following request payload:, _(*97)

{
    "name": "Status"
}

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

This is the canonical endpoint for RPC resources., _(*98)

• Accept: application/json, _(*99)

  Returns either a single RPC resource (when a controller_service_name is provided) or a collection of RPC resources (when no controller_service_name is provided) on success., _(*100)

• Content-Type: application/json, _(*101)

  Expects an object with the property "service_name" describing the endpoint to create., _(*102)

  You may also provide any other options listed in the RPC resource., _(*103)

• Collection Methods: GET, POST, _(*104)

• Resource Methods: GET, PATCH, _(*105)

• The query string variable version may be passed to the collection to filter results by version: e.g., /admin/api/module/:name/rpc?version=2., _(*106)

• Errors: application/problem+json, _(*107)

The minimal request payload necessary will have the following structure:, _(*108)

{
    "service_name": "Status"
}

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

This service is for creating, updating, and deleting named input filters associated with a given RPC service., _(*109)

• Accept: application/json, _(*110)

  Returns either a single input filter (when an input_filter_name is provided) or a collection of input filters (when no input_filter_name is provided) on success. Typically, only one input filter will be associated with a given RPC service., _(*111)

  Input filters returned will also compose a property input_filter_name, which is the identifier for the given input filter., _(*112)

• Content-Type: application/json, _(*113)

  Expects an input filter., _(*114)

• Collection Methods: GET, POST, _(*115)

• Resource Methods: GET, PUT, DELETE, _(*116)

• Errors: application/problem+json, _(*117)

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

This is the canonical endpoint for REST resources., _(*118)

Can be used for any type of REST resource, including DB-Connected., _(*119)

DB-Connected resources expect the following additional properties (and will return them as well):, _(*120)

• adapter_name: A named DB adapter service.
• table_name: The database table associated with this service.
• hydrator_name: Optional; the name of a hydrator service used to hydrate rows returned by the database; defaults to ArraySerializable.

• table_service: Optional; this is auto-generated by default, but an alternate TableGateway service may be provided., _(*121)

• Accept: application/json, _(*122)

  Returns either a single REST resource (when a controller_service_name is provided) or a collection of REST resources (when no controller_service_name is provided) on success., _(*123)

• Content-Type: application/json, _(*124)

  Expects an object with the property resource_name describing the REST service to create., _(*125)

  You may also provide any other options listed in the REST resource., _(*126)

• Collection Methods: GET, POST, DELETE, _(*127)

• Resource Methods: GET, PATCH, _(*128)

• The query string variable version may be passed to the collection to filter results by version: e.g., /admin/api/module/:name/rest?version=2., _(*129)

• Errors: application/problem+json, _(*130)

The minimum structure for creating a new REST service will appear as follows:, _(*131)

{
    "resource_name": "Status"
}

api/package

This endpoint is for building a deploy package for APIs., _(*132)

• Accept: application/json, _(*133)

  Returns a JSON structure on success, an API-Problem payload on error., _(*134)

• Content-Type: application/json, _(*135)

  Expects an object with the property "format", for the file format ZIP, TAR, TGZ, and ZPK; an "apis" property with a list of the API to include in the package; a "composer" property that specify if execute composer or not and an optional "config" property containing the path to an application config folder to be used in the package., _(*136)

• Methods: GET, POST, _(*137)

• Errors: application/problem+json, _(*138)

The request payload for POST should have the following structure:, _(*139)

{
    "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"
}

On success, the service returns the followings structure:, _(*140)

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

The fields of this response can be used in the GET method to download the package file. Basically, the token is a temporary file name stored in the system temporary folder (/tmp in GNU/Linux)., _(*141)

The request payload for GET should have the following structure:, _(*142)

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

On success, the service returns the file as application/octet-stream content type., _(*143)

API Models

The following is a list of various models either returned via the API endpoints listed above, or expected for the request bodies., _(*144)

authentication

HTTP Basic authentication:

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

HTTP Digest authentication:

{
    "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 authentication:

{
    "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"
}

authentication2

HTTP Basic authentication:

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

HTTP Digest authentication:

{
    "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 authentication (with 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 authentication (with 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)"
}

authorization

{
    "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 services have an entry for each of their entity and collection instances. RPC services have an entry per action name that is exposed (this will typically only be one). Each service has a list of HTTP methods, with a flag. A false value indicates that no authorization is required; a true value indicates that authorization is required., _(*145)

Note: If the deny_by_default flag is set in the application, then the meaning of the flags is reversed; true then means the method is public, false means it requires authentication., _(*146)

db-adapter

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

Additionally, any other properties used to create the Zend\Db\Adapter\Adapter instance may be composed: e.g., "username", "password", etc., _(*147)

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"
                }
            }
        ]
    }
}

An input filter may contain any number of inputs, and the format follows that used by Zend\InputFilter\Factory as described in the [Zend Framework 2 input filter documentation] (http://framework.zend.com/manual/2.3/en/modules/zend.input-filter.intro.html)., _(*148)

Currently, we do not allow nesting input filters., _(*149)

module

{
    "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"
    ]
}

Additionally, the module resource composes relational links for RPC and REST resources; these use the relations "rpc" and "rest", respectively., _(*150)

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 Events

Listeners

ZF\Apigility\Admin\Module

This listener is attached to MvcEvent::EVENT_RENDER at priority 100. It is responsible for conditionally attaching a listener depending on if the controller service result is that of an entity or that of a collection. If either is detected, the listener is attached to the ZF\Hal\Plugin\Hal events renderEntity and renderCollection.entity, which ensures they will be dispatched when the HAL plugin has an opportunity to start rendering., _(*151)

ZF2 Services

Models

Many of the model services provided by zf-apigility-admin either deal with the generation and modification of PHP code, or the generation and modification of PHP based configuration files., _(*152)

• ZF\Apigility\Admin\Model\AuthenticationModel - responsible for creating and modifying the authentication specific configuration of HTTP Basic, HTTP Digest and OAuth2 strategies. Sensitive information will be written to local configuration files while structural information is written to global and module files.
• ZF\Apigility\Admin\Model\AuthorizationModelFactory - responsible for writing the authorization specific details (the ACL matrix of allow/disallow rules) to the module configuration file.
• ZF\Apigility\Admin\Model\ContentNegotiationModel - responsible for writing custom content-negotiation selectors to the global configuration file.
• ZF\Apigility\Admin\Model\ContentNegotiationResource - REST resource that consumes the ContentNegotiationModel in order to expose an API endpoint for content-negotiation configuration management.
• ZF\Apigility\Admin\Model\DbAdapterModel - responsible for writing database adapter specific configuration between application level global and local configuration files. Sensitive information is written to local configuration files.
• ZF\Apigility\Admin\Model\DbAdapterResource - REST resource that consumes the DbAdapterModel in order to expose an API endpoint for database adapter configuration management.
• ZF\Apigility\Admin\Model\DbConnectedRestServiceModel - responsible for writing the required configuration information necessary to expose a database table as a REST resource.
• ZF\Apigility\Admin\Model\DocumentationModel - responsible for writing a special named file in the module's configuration directory that will contain all custom API documentation for requests, responses, and all other documentable elements of an API.
• ZF\Apigility\Admin\Model\InputFilterModel - responsible for writing the input filter specification configuration for each module.
• ZF\Apigility\Admin\Model\FiltersModel - responsible for providing, through the API, a list of built-in filters and their metadata.
• ZF\Apigility\Admin\Model\HydratorsModel - responsible for configuring and managing the global list of hydrator service names.
• ZF\Apigility\Admin\Model\ModuleModel - responsible for aggregating module information including REST and RPC services and exposing this information through the API. Additionally, when creating a new module, this will create the code artifacts necessary for an Apigility-enabled module.
• ZF\Apigility\Admin\Model\ModuleResource - responsible for exposing the ModuleModel as a REST resource in the Apigility API.
• ZF\Apigility\Admin\Model\RestServiceModel - responsible for presenting REST services, as they are defined in zf-rest in a way that can be created and modified, to be used in the Admin UI.
• ZF\Apigility\Admin\Model\RestServiceResource - responsible for consuming RestServiceModel and exposing this model as a REST resource in the Apigility API.
• ZF\Apigility\Admin\Model\RestServiceModelFactory - responsible for creating RestServiceModels.
• ZF\Apigility\Admin\Model\RpcServiceModel - responsible for presenting RPC services, as they are defined in zf-rpc in a way that can be created and modified, to be used in the Admin UI.
• ZF\Apigility\Admin\Model\RpcServiceResource - responsible for consuming RpcServiceModels and exposing this model as a REST resource in the Apigility API.
• ZF\Apigility\Admin\Model\RpcServiceModelFactory - responsible for creating RpcServiceModels.
• ZF\Apigility\Admin\Model\ValidatorsModel - responsible for providing, through the API, a list of available validators.
• ZF\Apigility\Admin\Model\ValidatorMetadataModel - responsible for providing metadata about validators provided through, and in conjunction with, the ValidatorModel and validator API.
• ZF\Apigility\Admin\Model\VersioningModel - responsible for modeling the workflow and module code creation artifacts that are required to provide a new version of a particular Apigility-based REST or RPC service.
• ZF\Apigility\Admin\Model\VersioningModelFactory - responsible for createing VersioningModels.