Code前端首页关于Code前端联系我们

laravel 界面开发—dingo 安装与配置

terry 2年前 (2023-09-25) 阅读数 61 #后端开发

Dingo Api 致力于提供一套工具来帮助你方便快捷地构建自己的 API
github: https://github.com/dingo/api /
wiki:/

安装

以下使用均在laravel环境下完成

包含组件

方法1
在方法2中添加指令
直接使用安装 Composer

composer require dingo/api:

以创建配置文件

运行以下命令以创建配置文件 /config/

php artisan vendor:publish

输入 dingo 号码并按 Enter。 configConfigrationFile

生成config

的配置文件定义为项目中的Config/您可以设置

#接口围绕:[x]本地和私有环境 [prs]公司内部app使用 [vnd]公开接口
'standardsTree' => env('API_STANDARDS_TREE', 'x')

#项目名称
'subtype' => env('API_SUBTYPE', 'laradmin')

#Api前缀 通过  来访问 API。
'prefix' => env('API_PREFIX', 'api')

#api域名
'domain' => env('API_DOMAIN', ''),

#版本号
'version' => env('API_VERSION', 'v1')

#开发时开启DEBUG便于发现错误
'debug' => env('API_DEBUG', false)

prefix和域,只有您可以选择一个两者,其中一项需要设置为null

.env设置示例

API_STANDARDS_TREE=vnd
API_SUBTYPE=myapp
API_PREFIX=api
#API_DOMAIN=api.myapp.com
API_VERSION=v1

中的接口路由route/文件描述
$api = app(\Dingo\Api\Routing\Router::class);

#默认配置指定的是v1版本,可以直接通过 {host}/api/version 访问到
$api->version('v1', function ($api) {
    $api->get('version', function () {
        return 'v1';
    });
    $api->get('abc', function () {
        return 'abc';
    });
});

#如果v2不是默认版本,需要设置请求头  
#Accept: application/[配置项standardsTree].[配置项subtype].v2+json
#Accept: application/
$api->version('v2', function ($api) {
    $api->get('version', function () {
        return 'v2';
    });
});

版权声明

本文仅代表作者观点,不代表Code前端网立场。
本文系作者Code前端网发表,如需转载,请注明页面地址。

发表评论:

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。

热门