stockraken/response

stockraken标准响应API

v1.01 2019-07-26 09:11 UTC

This package is auto-updated.

Last update: 2024-09-29 05:02:37 UTC


README

Stockraken标准响应

需求

这是作为Laravel 5.X库使用的响应,但如果没有Laravel 5.X,则此库无法使用。

返回响应

默认生成的响应是JSON格式

安装或部署

  1. 通过终端/命令提示符进入Laravel根目录
  2. 使用以下代码安装:composer require stockraken/response
  3. 完成后,打开laravel项目目录下的composer.json文件
  4. 在psr-4中添加Autoload "Stockraken\\Response\\": "vendor/stockraken/response/src"

之前

autoload": {
        "psr-4": {
        // psr-4 bawaan package lain seperti App\\app
        }
}

之后

autoload": {
        "psr-4": {
        // psr-4 bawaan package lain seperti App\\app
        "Stockraken\\Response\\": "vendor/stockraken/response/src"
        }
}
  1. 使用终端进入laravel项目根目录
  2. 运行以下命令:composer dump-autoload
  3. 确保过程没有错误,如果遇到错误,请在项目中提交ISSUE
  4. 使用serve命令运行laravel项目:php artisan serve
  5. 检查是否安装了response库,通过访问laravel项目URL(例如http://127.0.0.1:8000),并添加url skresponsehttp://127.0.0.1:8000/skresponse

库的使用

  • 创建新的控制器
  • 在控制器中添加stockraken库,通过添加use Stockraken\Response\Response;。如果需要,添加别名以缩短和简化编码。

示例

<?php

namespace App\Http\Controllers;

use App\User;
use Illuminate\Http\Request;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Stockraken\Response\Response as skresponse; // menggunakan alias skresponse, anda bisa mengubah alias sesuai keinginan anda

class PassportController extends Controller
{

    public function contoh()
    {
    }

}
 
  • 运行响应

示例

<?php

namespace App\Http\Controllers;

use App\User;
use Illuminate\Http\Request;
use Illuminate\Foundation\Auth\AuthenticatesUsers;
use Stockraken\Response\Response as skresponse; // menggunakan alias skresponse, anda bisa mengubah alias sesuai keinginan anda

class PassportController extends Controller
{

    public function contoh()
    {
        $ar = array(
            "contohdata" => "contoh isi data",
            "nilai" => 123,
            "test" => [1,2,3,4,5,9,10]
        );
        
        skresponse::$status = true; // status response terserah anda bisa true/false atau 'ok'/'no'
        skresponse::$message= "Berhasil ambil data"; // pesan yang akan ditampilkan pada response
        skresponse::$code   = 200; // kode response header, misal 200 untuk sukses, 404 untuk data tidak ditemukan, 501 untuk server error dll
        skresponse::$data   = $ar; // set data ke response
        
        return skresponse::run(); // mengmebalikan nilai
    }

}
 
  • 通过在laravel中添加路由并指向新创建的控制器进行测试,例如
Route::get('contoh', 'PassportController@contoh');