快捷導(dǎo)航

基于laravel制作APP接口（API）

更新時間：2016年03月15日 10:03:52 投稿：hebedich

這篇文章主要介紹了基于laravel制作APP接口（API）的相關(guān)資料,需要的朋友可以參考下

前期準備

前言，為什么做以及要做個啥
本人姓小名白，不折不扣編程屆小白一名，但是自從大一那會兒接觸到編程這件奇妙的事情，就完完全全的陷入的程序的世界。

這不，最近又開始折騰APP了，話說現(xiàn)在開發(fā)一款A(yù)PP真是容易，只用JavaScript和一點點HTML+css技術(shù)就可以完成。但是做APP的后臺就不一樣了。開發(fā)了APP，想讓讀點數(shù)據(jù)進去，那我們就要去開發(fā)個后臺了。

laravel框架，是我最喜歡的PHP框架了，沒有之一。去年就曾經(jīng)用laravel寫了我的個人網(wǎng)站但粗糙程度讓我十分臉紅，好了不扯了，讓我們直接進入主題——先安裝laravel吧！

基礎(chǔ)環(huán)境配置

具體的步驟直接看文檔吧laravel5.2安裝

我自己的環(huán)境是win10上面安裝了wampsrver2.5，但是這里值得好好注意一下，用wampsrver2.5了話，這幾個地方要改動一下。關(guān)于這個請看我的筆記點擊預(yù)覽
工具：sublime
瀏覽器：chrome（要用到的插件postman）

關(guān)于API

API（Application Programming Interface,應(yīng)用程序編程接口）是一些預(yù)先定義的函數(shù)，目的是提供應(yīng)用程序與開發(fā)人員基于某軟件或硬件得以訪問一組例程的能力，而又無需訪問源碼，或理解內(nèi)部工作機制的細節(jié)。
需要注意的是：API有它的具體用途，我們應(yīng)該清楚它是干啥的。訪問API的時候應(yīng)該輸入什么。訪問過API過后應(yīng)該得到什么。

在開始設(shè)計API時，我們應(yīng)該注意這8點
這里的內(nèi)容摘抄自大神的博客
后續(xù)的開發(fā)計劃就圍繞著這個進行了。（真心好棒的總結(jié)）

1.Restful設(shè)計原則
2.API的命名
3.API的安全性
4.API返回數(shù)據(jù)
5.圖片的處理
6.返回的提示信息
7.在線API測試文檔
8.在app啟動時，調(diào)用一個初始化API獲取必要的信息

用laravel開發(fā)API

就在我上愁著要不要從零開始學(xué)習(xí)的時候，找到了這個插件dingo/api那么現(xiàn)在就來安裝吧！
首先一定是下載的沒錯
在新安裝好的laravel的composer.json加入如下內(nèi)容

然后打開cmd執(zhí)行

composer update

在config/app.php中的providers里添加

App\Providers\OAuthServiceProvider::class,
Dingo\Api\Provider\LaravelServiceProvider::class,
LucaDegasperi\OAuth2Server\Storage\FluentStorageServiceProvider::class,
LucaDegasperi\OAuth2Server\OAuth2ServerServiceProvider::class,

在aliases里添加

'Authorizer' => LucaDegasperi\OAuth2Server\Facades\Authorizer::class,

修改app/Http/Kernel.php文件里的內(nèi)容

protected $middleware = [\LucaDegasperi\OAuth2Server\Middleware\OAuthExceptionHandlerMiddleware::class,
];
protected $routeMiddleware = [
  'oauth' => \LucaDegasperi\OAuth2Server\Middleware\OAuthMiddleware::class,
  'oauth-user' => \LucaDegasperi\OAuth2Server\Middleware\OAuthUserOwnerMiddleware::class,
  'oauth-client' => \LucaDegasperi\OAuth2Server\Middleware\OAuthClientOwnerMiddleware::class,
  'check-authorization-params' => \LucaDegasperi\OAuth2Server\Middleware\CheckAuthCodeRequestMiddleware::class,
  'csrf' => \App\Http\Middleware\VerifyCsrfToken::class,
];

然后執(zhí)行

php artisan vendor:publish 
php artisan migrate

在.env文件里添加這些配置

API_STANDARDS_TREE=x
API_SUBTYPE=rest
API_NAME=REST
API_PREFIX=api
API_VERSION=v1
API_CONDITIONAL_REQUEST=true
API_STRICT=false
API_DEBUG=true
API_DEFAULT_FORMAT=json

修改app\config\oauth2.php文件

'grant_types' => [
  'password' => [
    'class' => 'League\OAuth2\Server\Grant\PasswordGrant',
    'access_token_ttl' => 604800,
    'callback' => '\App\Http\Controllers\Auth\PasswordGrantVerifier@verify',
  ],
],

新建一個服務(wù)提供者，在app/Providers下新建OAuthServiceProvider.php文件內(nèi)容如下

namespace App\Providers;

use Dingo\Api\Auth\Auth;
use Dingo\Api\Auth\Provider\OAuth2;
use Illuminate\Support\ServiceProvider;

class OAuthServiceProvider extends ServiceProvider
{
  public function boot()
  {
    $this->app[Auth::class]->extend('oauth', function ($app) {
      $provider = new OAuth2($app['oauth2-server.authorizer']->getChecker());

      $provider->setUserResolver(function ($id) {
        // Logic to return a user by their ID.
      });

      $provider->setClientResolver(function ($id) {
        // Logic to return a client by their ID.
      });

      return $provider;
    });
  }

  public function register()
  {
    //
  }
}

然后打開routes.php添加相關(guān)路由

//Get access_token
Route::post('oauth/access_token', function() {
   return Response::json(Authorizer::issueAccessToken());
});

//Create a test user, you don't need this if you already have.
Route::get('/register',function(){
  $user = new App\User();
   $user->name="tester";
   $user->email="test@test.com";
   $user->password = \Illuminate\Support\Facades\Hash::make("password");
   $user->save();
});
$api = app('Dingo\Api\Routing\Router');

//Show user info via restful service.
$api->version('v1', ['namespace' => 'App\Http\Controllers'], function ($api) {
  $api->get('users', 'UsersController@index');
  $api->get('users/{id}', 'UsersController@show');
});

//Just a test with auth check.
$api->version('v1', ['middleware' => 'api.auth'] , function ($api) {
  $api->get('time', function () {
    return ['now' => microtime(), 'date' => date('Y-M-D',time())];
  });
});

分別創(chuàng)建BaseController.php和UsersController.php內(nèi)容如下

//BaseController
namespace App\Http\Controllers;

use Dingo\Api\Routing\Helpers;
use Illuminate\Routing\Controller;

class BaseController extends Controller
{
  use Helpers;
}

//UsersController
namespace App\Http\Controllers;

use App\User;
use App\Http\Controllers\Controller;

class UsersController extends BaseController
{

  public function index()
  {
    return User::all();
  }

  public function show($id)
  {
    $user = User::findOrFail($id);
    // 數(shù)組形式
    return $this->response->array($user->toArray());
  }
}

隨后在app/Http/Controllers/Auth/下創(chuàng)建PasswordGrantVerifier.php內(nèi)容如下

namespace App\Http\Controllers\Auth;
use Illuminate\Support\Facades\Auth;

class PasswordGrantVerifier
{
  public function verify($username, $password)
  {
     $credentials = [
      'email'  => $username,
      'password' => $password,
     ];

     if (Auth::once($credentials)) {
       return Auth::user()->id;
     }

     return false;
  }
}

打開數(shù)據(jù)庫的oauth_client表新增一條client數(shù)據(jù)

INSERT INTO 'oauth_clients' ('id', 'secret', 'name', 'created_at', 'updated_at') VALUES ('1', '2', 'Main website', '2016–03–13 23:00:00', '0000–00–00 00:00:00');

隨后的就是去愉快的測試了，這里要測試的API有

新增一個用戶

http://localhost/register

讀取所有用戶信息

http://localhost/api/users

只返回用戶id為4的信息

http://localhost/api/users/4

獲取access_token

http://localhost/oauth/access_token

利用token值獲得時間，token值正確才能返回正確值

http://localhost/api/time

打開PostMan