如何解决RESTfulAPI硬编码问题？LaminasAPIToolsHAL助你构建可发现的超媒体API

<code class="bash">composer require laminas-api-tools/api-tools-hal</code>

<code class="php">return [
    /* ... */
    'modules' => [
        /* ... */
        'Laminas\ApiTools\Hal',
    ],
    /* ... */
];</code>

<code class="php">// config/autoload/api-tools-hal.global.php
return [
    'api-tools-hal' => [
        'metadata_map' => [
            'App\V1\Entity\UserEntity' => [
                'entity_identifier_name' => 'id',
                'route_name'             => 'api.rest.user', // 假设你有一个名为'api.rest.user'的路由
                'route_identifier_name'  => 'user_id',
                'hydrator'               => 'App\V1\Hydrator\UserHydrator', // 自定义Hydrator
                'links'                  => [
                    [
                        'rel'   => 'posts', // 关联到用户的文章
                        'route' => [
                            'name'   => 'api.rest.user-posts', // 获取用户文章列表的路由
                            'params' => ['user_id' => 'id'], // 使用当前用户的ID
                        ],
                    ],
                ],
            ],
            'App\V1\Entity\PostEntity' => [
                'entity_identifier_name' => 'id',
                'route_name'             => 'api.rest.post',
                'route_identifier_name'  => 'post_id',
                'hydrator'               => 'App\V1\Hydrator\PostHydrator',
                'links'                  => [
                    [
                        'rel'   => 'author', // 关联到文章的作者
                        'route' => [
                            'name'   => 'api.rest.user',
                            'params' => ['user_id' => 'author_id'], // 假设PostEntity有author_id字段
                        ],
                    ],
                    [
                        'rel'   => 'comments', // 关联到文章的评论
                        'route' => [
                            'name'   => 'api.rest.post-comments',
                            'params' => ['post_id' => 'id'],
                        ],
                    ],
                ],
            ],
            // ... 其他实体配置
        ],
    ],
];</code>

<code class="php">use Laminas\ApiTools\Hal\View\HalJsonModel;
use Laminas\Mvc\Controller\AbstractRestfulController;

class UserController extends AbstractRestfulController
{
    public function get($id)
    {
        // 假设你从数据库获取了一个用户实体
        $user = $this->userService->getUserById($id); 

        if (!$user) {
            $this->getResponse()->setStatusCode(404);
            return;
        }

        // 使用Hal插件将User实体转换为HAL表示
        return new HalJsonModel($user);
    }
}</code>

<code class="json">{
    "id": 123,
    "name": "张三",
    "email": "zhangsan@example.com",
    "_links": {
        "self": {
            "href": "/users/123"
        },
        "posts": {
            "href": "/users/123/posts"
        }
    }
}</code>