app version provider for Laravel 5

About

laravel-version-service将添加用于查询代码的版本信息的接口。

Installation

composer require jiejunf/laravel-version-service

如果 laravel 的版本 < 5.5 ，还需要将 VersionService\VersionServiceProvider 添加到 config/app.php 的 providers 数组中。

Configuration

使用以下命令发布默认的配置文件到config/version.php

php artisan vendor:publish --provider="Jiejunf\VersionService\VersionServiceProvider"

参数区分客户端及服务端，根据需求配置合适的参数

app_type参数为同平台多版本配置，如Android平台上有雇主/雇员、商户/顾客/企业之类的不同版本,若无多版本可填写单一版本或至空(为空数组时此路由参数将被移除)

server_enable参数为false时，服务端接口无法请求

注意：配置信息会影响迁移、路由、控制器

Usage

• 客户端

  客户端接口需要迁移数据表，迁移前请根据项目配置好参数参数信息

  php artisan migrate --path="vendor/jiejunf/laravel-version-service/src/migrations"
  

  以下路由的参数均来自config/version.php

  获取最新版本

  • GET /{app_prefix}/{type}/{platform}/latest

  • Headers

    name	required	type	desc
    App-Version		string	外版本号,参数影响此版本到最新版本是否需要强制更新

    在config.version.app_header中设定

  获取版本列表

  • GET /{app_prefix}/{type}/{platform}

  更新版本信息

  • PUT /{app_prefix}/

  • Body

    name	required	type	desc
    platform	required	string	平台，必须是配置中的一个
    app_type	required	string	类型，必须是配置中的一个；没有配置时可无
    app_version	required	string	外部版本号：v1.0.2
    is_force_update		string	必须是 y 或 n 中的一个，为空时默认为y
    download_path		string	此版本的下载地址
    description		string	版本描述内容
    version_id	required	string	为空字符或历史版本中的一个

• 服务端

  服务端接口运行需要开启exec(),shell_exec()运行权限,且网络用户对项目目录具有正确的权限。配置项目目录权限

  获取当前服务器的代码版本

  • GET /{server_prefix}

  拉取服务器远程主线代码

  测试用，生产环境中此功能不可靠。网络用户需要配置远程仓库ssh公钥

  • POST /{server_prefix}/update

License

根据MIT许可证发布, 见LICENSE.