基于laravel制作API接口

拼搏现实的明天。 2023-02-14 02:44 37阅读 0赞

基于laravel制作API接口

**关于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

我的官方群[点击此处][Link 1]。链接加入群聊**【PHP/web/高级学习交流群】**,一起学习，相互讨论。

群内已经有管理将知识体系整理好（**源码，学习视频等资料**），欢迎**加群免费领取**。

这套精品**PHP教程**绝不是市场上的那些妖艳贱货可比，作为web开发的佼佼者PHP并不逊色其他语言，加上**Swoole**后更加是如虎添翼！进军通信 、物联网行业开发百度地图、百度订单中心、虎牙、战旗TV等！寒冬裁员期过后正是各大企业扩大招人的时期，现在市场初级程序员泛滥，进阶中高级程序员绝对是各大企业急需的人才，**这套学习教程适合那些1-5年以内的PHP开发者正处于瓶颈期，想要突破自己进阶中高级、架构师！名额有限，先到先得！**

[八重樱：腾讯T3-T4标准精品PHP架构师教程目录大全，只要你看完保证薪资上升一个台阶（持续更新）zhuanlan.zhihu.com![图标][format_png]][T3-T4_PHP_zhuanlan.zhihu.com_format_png]

### 部分资料截图： ###

![format_png 1][]

![format_png 2][]

![format_png 3][]

![format_png 4][]

![format_png 5][]

**还有限时精品福利：**

★腾讯高级PHP工程师笔试题目

★亿级PV高并发场景订单的处理

★laravel开发天猫商城组件服务

★战旗TV视频直播的架构项目实战

### 扫描下面二维码领取 ###

![format_png 6][]

对PHP后端技术，对PHP架构技术感兴趣的朋友，我的官方群[点击此处][Link 1]，一起学习，相互讨论。

群内已经有管理将知识体系整理好（源码，学习视频等资料），欢迎加群免费领取。

本课程深度对标腾讯T3-T4标准，贴身打造学习计划为web开发人员进阶中高级、架构师提升技术，为自己增值涨薪！**加入BAT特训营还可以获得内推大厂名额以及GO语言学习权限！**！！

[Link 1]: https://link.zhihu.com/?target=https%3A//jq.qq.com/%3F_wv%3D1027%26k%3D5kN6y8c
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS96aGlodS1jYXJkLWRlZmF1bHRfaXBpY28uanBn?x-oss-process=image/format,png
[T3-T4_PHP_zhuanlan.zhihu.com_format_png]: https://zhuanlan.zhihu.com/p/102278033
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMxLnpoaW1nLmNvbS84MC92Mi01ZWIxMmRmNzlmZjViYzRlNDAzNDkzZGY0Y2U2MGI5NF83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi1lNDBjZTllN2I2NmVmOWVmZjUzYWY1NmFhNjAwYWY3NV83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMxLnpoaW1nLmNvbS84MC92Mi00ZDBhYjc1NjVhM2M1ZGQ5ZTJkMTA1MjdhOWZjNTkzY183MjB3LmpwZw?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMxLnpoaW1nLmNvbS84MC92Mi02YmU4MGZlYmI5YjJiOGUzODkzYmFlNGVhY2ZlMzQyMF83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi0yMGY3NjRlOTdjZDkxZDdkNGMxZmJmZTExMzA2MDk5ZF83MjB3LmpwZw?x-oss-process=image/format,png
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9waWMyLnpoaW1nLmNvbS84MC92Mi1lODBlNjJlMzFhMDUyZjNlODIwOTI5YzUzYWE5ZmIzOV83MjB3LmpwZw?x-oss-process=image/format,png