Laravel5.3开发API(Dingo+Passport+Swagger)

原创 2016年12月01日 21:33:49

dingo/api


安装

composer require dingo/api:1.0.x@dev

配置

config/app.php 注册服务提供者

...
'providers' => [
    ...
    Dingo\Api\Provider\LaravelServiceProvider::class,
    ...
],
...

生成配置文件config/api.php

php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"

设置.env

phpAPI_STANDARDS_TREE=vnd
API_SUBTYPE=biubiujun
API_PREFIX=api
API_VERSION=v1
API_NAME=BiuBiuJun
API_CONDITIONAL_REQUEST=false
API_STRICT=false
API_DEFAULT_FORMAT=json
API_DEBUG=true

API_STANDARDS_TREE - API规格
x 本地或私有环境
prs 非商业销售的项目
vnd 公开的以及商业销售的项目

API_SUBTYPE - API简称
API_PREFIX - API前缀(或使用API_DOMAIN - API子域名)
API_VERSION - API默认版本
API_NAME - API名称
API_CONDITIONAL_REQUEST - 带条件的请求,由于缓存API请求的时候会使用客户端缓存功能,所以默认开启了带条件的请求
API_STRICT - 严格模式,要求客户端发送Accept头而不是默认在配置文件中指定的版本
API_DEFAULT_FORMAT - 响应格式,默认的响应格式是JSON
API_DEBUG - 调试模式

测试

迁移User数据表

php artisan migrate

创建UserTableSeeder

php artisan make:seeder UserTableSeeder

修改database/seeds/UserTableSeeder.php

<?php
use Illuminate\Database\Seeder;

class UsesTableSeeder extends Seeder
{
    /**
      * Run the database seeds. 
      * 
      * @return void
      */
    public function run()
    {
        $user = new User();
        $user->name = 'BiuBiuJun';
        $user->email = 'biubiujun@163.com';
        $user->password = Hash::make('123456');
        $user->save();
    }
}

执行seeder

php artisan db:seed

创建UserController

php artisan make:controller Api/V1/UserController

修改app/Http/Controller/Api/V1/UserController

<?php
namespace App\Http\Controllers\Api\V1;

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

class UserController extends Controller
{
    public function index()
    {
        return User::all();
    }

    public function show($id)
    {
        return User::findOrFail($id);
    }
}

routes/api.php注册路由

...
$api = app('Dingo\Api\Routing\Router');
$api->version('v1', ['namespace' => 'App\Http\Controllers\Api\V1'], function ($api) {
    $api->get('user/{id}', 'UserController@show');
    $api->get('user', 'UserController@index');
});

查看路由列表

php artisan api:routes

访问即可
http://localhost/path/public/api/user
http://localhost/path/public/api/user/1

Passport


安装

composer require laravel/passport

配置

config/app.php注册服务提供者

...
'providers' => [
    ...
    Laravel\Passport\PassportServiceProvider::class,
    ...
],
...

迁移Passport相关的数据表

php artisan migrate

修改app/User.php

<?php
namespace App;

use Laravel\Passport\HasApiTokens;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use HasApiTokens, Notifiable;
}

创建AuthServiceProvider

php artisan make:provider AuthServiceProvider

修改app/Providers/AuthServiceProvider

<?php

namespace App\Providers;

use Carbon\Carbon;
use Laravel\Passport\Passport;
use Illuminate\Support\Facades\Gate;
use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;

class AuthServiceProvider extends ServiceProvider
{
    /**
     * The policy mappings for the application.
     *
     * @var array
     */
    protected $policies = [
        'App\Model' => 'App\Policies\ModelPolicy',
    ];

    /**
     * Register any authentication / authorization services.
     *
     * @return void
     */
    public function boot()
    {
        $this->registerPolicies();

        Passport::routes();

        Passport::tokensExpireIn(Carbon::now()->addDays(15));

        Passport::refreshTokensExpireIn(Carbon::now()->addDays(30));

        Passport::pruneRevokedTokens();
    }
}

修改config/auth.php

...
 'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],

        'api' => [
            'driver' => 'passport',
            'provider' => 'users',
        ],
    ],
...

创建一个密码发放客户端

php artisan passport:client --password

配置Dingo使用Passport密码发放令牌

创建PassportDingoProvider

php artisan make:provider PassportDingoProvider

修改app/Providers/PassportDingoProvider.php

<?php
namespace App\Providers;

use Dingo\Api\Routing\Route;
use Illuminate\Http\Request;
use Dingo\Api\Auth\Provider\Authorization;

class PassportDingoProvider extends Authorization
{
    public function authenticate(Request $request, Route $route)
    {
        return $request->user();
    }

    public function getAuthorizationMethod()
    {
        return 'bearer';
    }
}

修改config/api.php

...
'auth' => [ 
    'custom' => \App\Providers\PassportDingoProvider::class
],
...

修改App/Http/Kernel.php

...
protected $middlewareGroups = [
   ...
   'api:auth' => [
       'auth:api',
       'api.auth'
    ]
    ...
];
...

routes/api.php修改之前注册路由

...
$api = app('Dingo\Api\Routing\Router');
$api->version('v1', ['middleware' => 'api:auth', 'namespace' => 'App\Http\Controllers\Api\V1'], function ($api) {
    $api->get('user/{id}', 'UserController@show');
    $api->get('user', 'UserController@index');
});

测试

请求令牌

curl -d "username=biubiujun@163.com@password=123456@grant_type=password&client_id=<client_id>&client_secret=<client_secret>" http://localhost/path/public/api/oauth/token

请求用户列表

curl -H "Authorization: Bearer <token>" http://localhost/path/public/api/user

Swagger


安装

composer require zircote/swagger-php

测试

创建SwaggerController

php artisan make:controller SwaggerController

修改app/Http/Controller/SwaggerController

<?php

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller;

/**
 * @SWG\Info(title="My First API", version="0.1")
 */

/**
 * @SWG\Get(
 *     path="/api/resource.json",
 *     @SWG\Response(response="200", description="An example resource")
 * )
 */
class SwaggerController extends Controller
{
    public function doc()
    {
        $swagger = \Swagger\scan(__DIR__ . '/../');

        return response()->json($swagger);
    }
}

下载swagger-ui
swagger-ui
swagger-ui/dist目录放入public/doc

修改public/doc/index.html

...
<script src='lang/translator.js' type='text/javascript'></script>
<script src='lang/zh-cn.js' type='text/javascript'></script>
<script type="text/javascript">
    $(function () {
      var url = window.location.search.match(/url=([^&]+)/);
        if (url && url.length > 1) {
          url = decodeURIComponent(url[1]);
        } else {
          // url = "http://petstore.swagger.io/v2/swagger.json"
          url = "/api/doc";
        }
    ...

访问http://localhost/path/public/doc/

版权声明:本文为博主原创文章,未经博主允许不得转载。

Laravel五大功能之Eloquent关系模式

Eloquent是Laravel的原始ActiveRecord是实现的,建立在Laravel的Fluent Query Builder之上的,所以Eloquent类和Fluent类是一样的,能实现...

laravel Passport Components not showing up in Laravel 5.5(走过的坑)

参考文档    https://laravel.com/docs/5.5/passport 按照官网文档一步步走下来, 一切都是很顺利的 直到npm run dev  passport compo...

Lumen上使用Dingo/Api做API开发时用JWT-Auth做认证的实现

使用Lumen和dingo/api开发api 服务时,使用tymon/jwt-auth来做认证部分的实现。
  • HOOLOO
  • HOOLOO
  • 2015年11月08日 03:09
  • 22298

laravel与dingoapi的结合使用

dingoapi的安装: 我是在我的centos服务器上安装laravel和dingoapi的,首先确保电脑上有相关的依赖:composer。 1、在指定的目录下先安装laravel:larave...

Dingo + Laravel + JWT + Entrust + memcache 实现API设计

Dingo + Laravel + JWT + Entrust + memcache 实现API设计 Dingo Api 是一个为laravel设计的用于API开发的开源包,规范和简化了Api的设...

laravel 开发RestFul接口【一、集成三方扩展 - dingo/api】

1、在laravel的根目录的composer.json 文件中引入 "dingo/api": "1.0.*@dev" 2、更新 composer执行composer update 3.注册服务提供...

Laravel实现dingo+JWT api接口之实战篇

上一篇文章讲解了如何配置安装包(点击这里),接下来讲解如何使用 这里我的需求比较特殊,使用的model并不是App/User,所以需要进行指定---》参考文章点击这里 ①新建数据库及其mode...

Swagger在Laravel项目中的使用

本篇讲述在如何快速在Laravel中引入Swagger并开始使用。安装首先是使用Laravel的一个composer:L5 Swagger。 下面是对应的各个版本。...
  • cckooo
  • cckooo
  • 2017年09月21日 21:17
  • 433

app后端开发一:swagger-ui教程-构建api接口文档工具

声明之前写过关于app后端开发的一系列文章,那是我第一次做app后端开发,存在很多不足,本想好好修改一下,想想还是重新写吧,这样子也能让我博客文章看起来多一点嘛,万一以后找工作,别人一看我博客这么多内...
  • hel12he
  • hel12he
  • 2015年06月18日 14:40
  • 35615

在Laravel5.2中使用dingo+JWT+Swagger

# laravel-dingo项目github地址laravel-dingo 结合dingo api、JWT、swagger等众多目前流行的restful api工具,致力于将laravel5.2...
  • turtleo
  • turtleo
  • 2016年02月25日 23:57
  • 4661
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Laravel5.3开发API(Dingo+Passport+Swagger)
举报原因:
原因补充:

(最多只允许输入30个字)