基于laravel制作APP接口(API)


Posted in PHP onMarch 15, 2016

前期准备

前言,为什么做以及要做个啥
本人姓小名白,不折不扣编程届小白一名,但是自从大一那会儿接触到编程这件奇妙的事情,就完完全全的陷入的程序的世界。

这不,最近又开始折腾APP了,话说现在开发一款APP真是容易,只用JavaScript和一点点HTML+css技术就可以完成。但是做APP的后台就不一样了。开发了APP,想让读点数据进去,那我们就要去开发个后台了。

laravel框架,是我最喜欢的PHP框架了,没有之一。去年就曾经用laravel写了我的个人网站但粗糙程度让我十分脸红,好了不扯了,让我们直接进入主题——先安装laravel吧!

基础环境配置

具体的步骤直接看文档吧laravel5.2安装

我自己的环境是win10上面安装了wampsrver2.5,但是这里值得好好注意一下,用wampsrver2.5了话,这几个地方要改动一下。关于这个请看我的笔记点击预览
工具:sublime
浏览器:chrome(要用到的插件postman)

关于API

API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数,目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力,而又无需访问源码,或理解内部工作机制的细节。
需要注意的是:API有它的具体用途,我们应该清楚它是干啥的。访问API的时候应该输入什么。访问过API过后应该得到什么。

在开始设计API时,我们应该注意这8点
这里的内容摘抄自大神的博客
后续的开发计划就围绕着这个进行了。(真心好棒的总结)

1.Restful设计原则
2.API的命名
3.API的安全性
4.API返回数据
5.图片的处理
6.返回的提示信息
7.在线API测试文档
8.在app启动时,调用一个初始化API获取必要的信息

用laravel开发API

就在我上愁着要不要从零开始学习的时候,找到了这个插件dingo/api那么现在就来安装吧!
首先一定是下载的没错
在新安装好的laravel的composer.json加入如下内容

然后打开cmd执行

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文件里的内容

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,
];

然后执行

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',
  ],
],

新建一个服务提供者,在app/Providers下新建OAuthServiceProvider.php文件内容如下

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添加相关路由

//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())];
  });
});

分别创建BaseController.php和UsersController.php内容如下

//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);
    // 数组形式
    return $this->response->array($user->toArray());
  }
}

随后在app/Http/Controllers/Auth/下创建PasswordGrantVerifier.php内容如下

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;
  }
}

打开数据库的oauth_client表新增一条client数据

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

基于laravel制作APP接口(API)

基于laravel制作APP接口(API)

基于laravel制作APP接口(API)

基于laravel制作APP接口(API)

PHP 相关文章推荐
用PHP产生动态的影像图
Oct 09 PHP
转PHP手册及PHP编程标准
Dec 17 PHP
PHPUnit PHP测试框架安装方法
Mar 23 PHP
php中强制下载文件的代码(解决了IE下中文文件名乱码问题)
May 09 PHP
本地机apache配置基于域名的虚拟主机详解
Aug 10 PHP
php冒泡排序与快速排序实例详解
Dec 07 PHP
Thinkphp连表查询及数据导出方法示例
Oct 15 PHP
php+ajax+json 详解及实例代码
Dec 12 PHP
PHP实现二维数组去重功能示例
Jan 12 PHP
php获取访问者浏览页面的浏览器类型
Jan 23 PHP
详解json在php中的应用
Sep 30 PHP
PhpStorm的使用教程(本地运行PHP+远程开发+快捷键)
Mar 26 PHP
使用Composer安装Yii框架的方法
Mar 15 #PHP
Yii使用migrate命令执行sql语句的方法
Mar 15 #PHP
YII Framework框架教程之使用YIIC快速创建YII应用详解
Mar 15 #PHP
php正则表达式验证(邮件地址、Url地址、电话号码、邮政编码)
Mar 14 #PHP
详解PHP实现异步调用的4种方法
Mar 14 #PHP
ThinkPHP框架安全实现分析
Mar 14 #PHP
php语言的7种基本的排序方法
Dec 28 #PHP
You might like
YII中assets的使用示例
2014/07/31 PHP
visual studio code 调试php方法(图文详解)
2017/09/15 PHP
设定php简写功能的方法
2019/11/28 PHP
PHP中关于php.ini参数优化详解
2020/02/28 PHP
Web 前端设计模式--Dom重构 提高显示性能
2010/10/22 Javascript
一个支付页面DEMO附截图
2014/07/22 Javascript
js实现的类似于asp数据字典的数据类型代码实例
2014/09/03 Javascript
Node.js实现批量去除BOM文件头
2014/12/20 Javascript
jQuery实现移动 和 渐变特效的点击事件
2015/02/26 Javascript
javascript实现点击提交按钮后显示loading的方法
2015/07/03 Javascript
JavaScript节点及列表操作实例小结
2015/08/05 Javascript
js中通过getElementsByName访问name集合对象的方法
2016/10/31 Javascript
简单实现jQuery上传图片显示预览功能
2020/06/29 jQuery
jquery实现倒计时小应用
2017/09/19 jQuery
手把手教你使用vue-cli脚手架(图文解析)
2017/11/08 Javascript
使用JavaScript解析URL的方法示例
2019/03/01 Javascript
利用Vue实现一个markdown编辑器实例代码
2019/05/19 Javascript
vue element el-transfer增加拖拽功能
2021/01/15 Vue.js
[03:53]2016国际邀请赛中国区预选赛第三日TOP10精彩集锦
2016/06/29 DOTA
Python 基于Twisted框架的文件夹网络传输源码
2016/08/28 Python
15行Python代码带你轻松理解令牌桶算法
2018/03/21 Python
在Python 中实现图片加框和加字的方法
2019/01/26 Python
Tensorflow模型实现预测或识别单张图片
2019/07/19 Python
PYTHON发送邮件YAGMAIL的简单实现解析
2019/10/28 Python
荷兰演唱会和体育比赛订票网站:viagogo荷兰
2018/04/08 全球购物
进口业务员岗位职责
2014/04/06 职场文书
员工考核评语大全
2014/04/26 职场文书
《放飞蜻蜓》教学反思
2014/04/27 职场文书
升旗仪式演讲稿
2014/05/08 职场文书
社团活动总结书
2014/06/27 职场文书
培养联系人考察意见
2015/06/01 职场文书
唐山大地震观后感
2015/06/05 职场文书
MySQL官方导出工具mysqlpump的使用
2021/05/21 MySQL
浅谈怎么给Python添加类型标注
2021/06/08 Python
CentOS MySql8 远程连接实战
2022/04/19 MySQL
Python 读取千万级数据自动写入 MySQL 数据库
2022/06/28 Python