美文网首页
Lumen初始化接口框架Dingo-api搭建

Lumen初始化接口框架Dingo-api搭建

作者: 学习上的Doge | 来源:发表于2019-10-16 13:52 被阅读0次

    一 安装composer

    安装说明  https://www.runoob.com/w3cnote/composer-install-and-usage.html

    二 安装Lumen

    1: 通过Lumen安装器

    ① 首先使用 Composer 下载 Lumen 安装包:

    composer global require "laravel/lumen-installer"

    ps:将  ~/.composer/vendor/bin 路径添加到环境变量 PATH 中,只有这样系统才能找到 lumen 的可执行文件。 设置环境变量:https://blog.csdn.net/u010770041/article/details/49915089

    ② Lumen 项目。例如: lumen new blog 命令将会创建一个名字叫 blog 的目录 ,此目录里面存放着新安装的。

    ③ 允许应用程序

    php -S localhost:8000 -t public

    ③ 将.env.example 复制重命名 .env 

    二 安装dingo-api

    2.1

    ① 你必须在你的项目中修改 composer.json 文件并且运行 composer update 命令来加载这个包的最新版本。

    "require": { 

     "dingo/api": "^2.2"

    }

    或直接执行命令

    composer require dingo/api

    ② 如果你使用 Lumen,请打开 bootstrap/app.php 并注册服务提供者:

    $app->register(Dingo\Api\Provider\LumenServiceProvider::class);

    ③ Standards Tree 标准树

    通过媒体类型来指定版本信息

    Accept:application/vnd.example.com.v1+json

    其中vnd表示Standards Tree标准树类型,有三个不同的树:x,prs和vnd。你使用的标准树需要取决于你开发的项目

    未注册的树(x)主要表示本地和私有环境

     私有树(prs)主要表示没有商业发布的项目

     供应商树(vnd)主要表示公开发布的项目

    ps:子类型使用私有和供应商树在技术上意味着在 IANA 上注册,但是并不强制要求。可以配置在.env 文件中

    API_STANDARDS_TREE=vnd

    ④ 子类型

    子类型通常是应用程序或项目的短名称,都是小写的。

    可以在.env文件中配置。

    API_SUBTYPE=myapp

    ⑤ 前缀和子域

    如果你曾经使用过 API 你就会知道大多数服务都来自子域或前缀。前缀或子域是必须的,但只需要一个。请避免使用版本号作为你的前缀或子域,因为版本控制是通过 header 头 Accept 处理的。.env文件中配置

    API_PREFIX=api

    或域名

    API_DOMAIN=api.myapp.com

    ⑥版本号 

    这个版本号是你的 API 的默认版本号,并且会在一些未提供版本号的情况下作为回调的默认值使用。在生成 API 文档时也会使用这个版本号作为默认值。.env文件中配置

    API_VERSION=v1

    ⑦ 条件请求

    『条件请求』默认为开启状态,这有利于客户端的缓存机制在可能的情况下缓存 API 请求。.env配置

    API_CONDITIONAL_REQUEST=false

    ⑧ 名称

    .env文件中配置

    API_NAME=My API  或需要用引号包起来 API_NAME="My API"

    详细访问地址:https://learnku.com/docs/dingo-api/2.0.0/Configuration/1444

    2.2 

    建立路由文件 我喜欢在routes文件下建立不同模块的路由文件夹 例如 User模块则建立 Usr文件夹放对应模块的路由。

    ps :app('Dingo\Api\Routing\Router')

    2.3 路由建立 例:

    相关文章

      网友评论

          本文标题:Lumen初始化接口框架Dingo-api搭建

          本文链接:https://www.haomeiwen.com/subject/ynejmctx.html