1,修改.env配置文件添加
API_STANDARDS_TREE=vnd API_SUBTYPE=myapp API_PREFIX=api API_DOMAIN=null API_VERSION=v1 API_NAME="My API" API_CONDITIONAL_REQUEST=false API_STRICT=false API_DEBUG=true
Standards Tree 標准樹
這有三個不同的樹: x,prs 和 vnd。你使用的標准樹需要取決於你開發的項目
未注冊的樹(x)主要表示本地和私有環境
私有樹(prs)主要表示沒有商業發布的項目
供應商樹(vnd)主要表示公開發布的項目
子類型SUBTYPE
子類型通常是應用程序或項目的短名稱,都是小寫的。
前綴PREFIX (比如www.z5w.net/api/)
如果你曾經使用過 API 你就會知道大多數服務都來自子域或前綴。前綴或子域是必須的,但只需要一個。請避免使用版本號作為你的前綴或子域,因為版本控制是通過 header 頭 Accept 處理的。
子域名API_DOMAIN
比如可以用api.z5w.net來做api的調用地址。如果已經設置了前綴prefix,則domain一般設為null
版本號version
這個版本號是你的 API 的默認版本號,並且會在一些未提供版本號的情況下作為回調的默認值使用。在生成 API 文檔時也會使用這個版本號作為默認值。
名稱Name
你的 API 的名稱只會在你使用 API Blueprint 命令生成文檔的時候使用。使用此名稱可以避免你每次生成文檔的時候都必須手動定義名稱。
你可能需要把它用引號包起來。
條件請求CONDITIONAL_REQUEST
『條件請求』默認為開啟狀態,這有利於客戶端的緩存機制在可能的情況下緩存 API 請求。
嚴格模式STRICT
嚴格模式要求客戶端發送 Accept 頭,代替配置文件中配置的默認版本。這意味着你將不能通過瀏覽器直接訪問你的 API。
如果開啟嚴格模式,發送非法的 Acceept 標頭會拋出一個未處理的異常 Symfony\Component\HttpKernel\Exception\BadRequestHttpException ,你需要自己處理這個異常。
調試模式Debug
該包處理的通用錯誤包括一個 debug 鍵,當啟用這個鍵時,將會填充堆棧跟蹤詳細信息。
2,在/routes/web.php添加路由
$api = app('Dingo\Api\Routing\Router'); $api->version('v1', function ($api) { $api->get('helloworld', 'App\Api\Controllers\HelloController@index'); });
3,創建文件/app/Api/Controllers/HelloController.php
<?php namespace App\Api\Controllers; use Illuminate\Http\Request; use App\Http\Controllers\Controller; class HelloController extends Controller { public function index() { return '{content:Helloworld!}'; } }
4,測試路由: $ php artisan api:routes,如果出現
+------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+ | Host | Method | URI | Name | Action | Protected | Version(s) | Scope(s) | Rate Limit | +------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+ | | GET|HEAD | /api/helloworld | | App\Api\Controllers\HelloController@index | No | v1 | | | +------+----------+-----------------+------+-------------------------------------------+-----------+------------+----------+------------+
表示成功
然后訪問http://www.*.com/api/helloworld,看看是不是出現了api的json數據呢?
{content:Helloworld!}