一、访问节流的限制

访问节流dingo/api文档

在routes\api.php中写入访问节流的限制代码：

<?php

$api = app('Dingo\Api\Routing\Router');

$api->version('v1',  ['middleware' => 'api.throttle', 'limit' => 3, 'expires' => 1,], function ($api) {
    $api->get('index', [\App\Http\Controllers\TestController::class, 'index']);

    // 命名路由
    $api->get('nickname', ['as' => 'test.nickname', 'uses' => '\App\Http\Controllers\TestController@nickname']);

    // 执行登陆
    $api->post('login', [\App\Http\Controllers\TestController::class, 'login']);

    // 需要登陆的路由
    $api->group(['middleware' => 'api.auth'], function($api) {
        $api->get('users', [\App\Http\Controllers\TestController::class, 'users']);
    });

});

在这里插入图片描述
接下来我们用postman点击4次，前3次都正常，最后一次：

二、内部调用

这个包的主要用途就是在 API 内部执行请求。它允许你在可用的 API 基础上构建你的应用。内部请求也可以返回原始数据，而不是原始响应对象，这意味着你可以获得与之相关的所有语法糖。------ 引用出处dingo/api内部调用

2.1 构建一个分发器实例来发起内部请求

1、普通请求

在routes\api.php下构建：

 // 内部调用
 $api->get('in', [\App\Http\Controllers\TestController::class, 'in']);

在TestController控制器下写入in方法：

public function in() {
        // 构建分发器实例
        $dispatcher = app('Dingo\Api\Dispatcher');
        // 进行内部请求
        $users = $dispatcher->get('api/index');
        return $users;
    }

效果：
在这里插入图片描述

2、模拟认证用户请求

如果你的 API 端点需要认证，你可以在内部模拟一个给定的用户。例如，用户使用 Laravel 的身份验证登录到应用，你可以取得用户，然后模拟用户发起内部请求。

在这里插入图片描述
文档这里be方法是用户实例，在用户请求的时候肯定有传token，那么我们在这里演示的话直接从数据库取一个用户：

        // 模拟用户
        $user = User::find(1);
        $users = $dispatcher->be($user)->get('api/users');
        return $users;

效果：
在这里插入图片描述

三、请求api版本

在这里插入图片描述

四、命令行工具与api文档

4.1 查看api路由

在这里插入图片描述

4.2 生成api文档

生成api文档链接
例子：

    /**
     * 用户登陆
     *
     * 使用 `username` 和 `password` 登陆用户。
     *
     * @Post("/login")
     * @Versions({"v1"})
     * @Transaction({
     *      @Request({"username": "foo", "password": "bar"}),
     *      @Response(200, body={"id": 10, "username": "foo"}),
     *      @Response(422, body={"error": {"username": {"Username is already taken."}}})
     * })
     */

在这里插入图片描述
运行生成文档命令行命令：
php artisan api:docs --output-file /home/vagrant/code/shopApi/document.md

效果（可以看到多了个document.md文件）：

但是这种查看有它自己的局限性，我们一般可以用线上的文档像showDocs。但是也要知道这种用命令直接生成的md的文档。
在这里插入图片描述

五、常见状态码

2xx：请求成功，表示成功处理了请求的状态代码。
3xx：请求被重定向，表示要完成请求，需要进一步操作，通常这些状态代码用来重定向，
4xx：请求错误，这些状态代码表示请求可能出错，妨碍了服务器的处理。
5xx：服务器错误，这些状态代码表示服务器在尝试处理请求时发生内部错误，这些错误可能是服务器本身的错误，而不是请求出错。