zf-metal/restful

Doctrine restful for Zend Framework 3

Maintainers

👁 cincarnato

Package info

github.com/zf-metal/restful

Homepage

pkg:composer/zf-metal/restful

Statistics

Installs: 174

Dependents: 2

Suggesters: 0

Stars: 1

Open Issues: 0

1.4.2 2020-11-05 18:12 UTC

MIT 70acfa094d8184c80c1fd0d1a8a835f4f8a655ab

zf3

This package is auto-updated.

Last update: 2026-06-06 06:39:48 UTC


README

Dependencies

  • "doctrine/doctrine-orm-module"
  • "zf-metal/commons"
  • "zf-metal/log"
  • "zendframework/zend-mvc"
  • "zendframework/zend-json"

Default Routes

Action: Get 1 item

  • Method: GET
  • URL: /zfmr/api/entityalias/:id

Action: Get list

  • Method: GET
  • URL: /zfmr/api/entityalias

Action: Create Item

  • Method: POST
  • URL: /zfmr/api/entityalias
  • Params: Entity Fields & Values

Action: Update Item

  • Method: PUT
  • URL: /zfmr/api/entityalias/:id
  • Params: Entity Fields & Values

Action: Delete Item

  • Method: DELETE
  • URL: /zfmr/api/entityalias/:id

Custom Routes

You can create your own restful routes and invoke \ZfMetal\Restful\Controller\MainController

<?php

return [
 'router' => [
 'routes' => [
 'zfmcErp' => [
 'type' => \Zend\Router\Http\Literal::class,
 'mayTerminate' => false,
 'options' => [
 'route' => '/custom/api',
 ],
 'child_routes' => [
 'api' => [
 'type' => \Zend\Router\Http\Segment::class,
 'mayTerminate' => false,
 'options' => [
 'route' => '/:entityAlias[/:id]',
 'defaults' => [
 'controller' => \ZfMetal\Restful\Controller\MainController::class,
 ],
 ],
 ],
 ],
 ],
 ],
 ]
];

Configure Entities

Add zf-metal-restful.global.php in config/autoload

<?php

return [
 'zf-metal-restful.options' => [
 'entity_aliases' => [
 'alias' => 'entity_class'
 ]
 ]
];