molchanoviv/retrofit-php

是 tebru/retrofit-php 的分支

v2.8.3 2016-09-12 14:47 UTC

README

Build Status Coverage Status Scrutinizer Code Quality SensioLabsInsight

这个库旨在简化REST客户端的创建。它明显借鉴了 square/retrofit 并用PHP实现。

概述

Retrofit 允许您使用简单的接口定义您的REST API。

<?php

use Tebru\Retrofit\Annotation as Rest;

interface GitHubService
{
    /**
     * @Rest\GET("/users/{user}/list")
     * @Rest\Returns("ArrayCollection<ListRepo>")
     */
    public function listRepos($user);
}

使用注解来配置端点。然后,RestAdapter 类生成服务接口的有效实现。

<?php

use Tebru\Retrofit\Adapter\RestAdapter;

$restAdapter = RestAdapter::builder()
    ->setBaseUrl('https://api.github.com')
    ->build();
    
$gitHubService = $restAdapter->create(GitHubService::class);

我们新创建的服务能够向 /users/$user/list 发送GET请求,以返回一个包含 ListRepo 对象的 ArrayCollection。

$repos = $gitHubService->listRepos('octocat');

使用示例参考自 Square 的文档

安装与使用

composer require tebru/retrofit-php

请确保您还安装了一个HTTP客户端。目前,只有 guzzle 是支持的选择

composer require guzzlehttp/guzzle

文档

许可证

本项目采用 MIT 许可证。有关更多信息,请参阅 LICENSE 文件。