快捷導(dǎo)航

Laravel5.3+框架定義API路徑取消CSRF保護(hù)方法詳解

更新時(shí)間：2020年04月06日 15:27:13 作者：Eagle L.

這篇文章主要介紹了Laravel框架定義API路徑取消CSRF保護(hù),需要的朋友可以參考下

從Laravel 5.3+開始，API路徑被放入了routes/api.php中。我們絕大多數(shù)的路徑其實(shí)都會(huì)在web.php中定義，因?yàn)樵趙eb.php中定義的路徑默認(rèn)有CSRF保護(hù)，而API路徑默認(rèn)沒有CSRF保護(hù)。在Laravel官網(wǎng)文檔中寫到：/p>

Any HTML forms pointing to POST, PUT, or DELETE routes that are defined in the web routes file should include a CSRF token field. Otherwise, the request will be rejected.

所以，請(qǐng)注意你頁(yè)面的表單中是否使用了POST、PUT或DELETE方法，如果有，并且你沒有在表單中添加相應(yīng)的CSRF token時(shí)，你的請(qǐng)求將會(huì)失敗。

有時(shí)候，我們可能不想要CSRF保護(hù)。比如我們想使用第三方軟件測(cè)試表單提交，或者比如微信公眾號(hào)接口的開發(fā)時(shí)，當(dāng)微信服務(wù)器使用POST推送給我們消息時(shí)，如果開啟了CSRF保護(hù)，那么請(qǐng)求肯定是失敗的。

在這樣的情況下，我們可以使用API路徑來(lái)取消CSRF保護(hù)。

我們有兩種辦法來(lái)定義API Routes。

第一種辦法：

將routes放進(jìn)VerifyCsrfToken這個(gè)middleware的$except數(shù)組里：

<?php      
  
namespace App\Http\Middleware;    
  
use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken as BaseVerifier;    
  
class VerifyCsrfToken extends BaseVerifier    
{      
  /**      
   * The URIs that should be excluded from CSRF verification.      
   *      
   * @var array      
   */      
  protected $except = [      
    '/api/my-route',      
  ];      
}

以上middleware的位置在app/Http/Middleware文件夾中。

第二種方法：

將routes放進(jìn)api.php里：

<?php      
  
use Illuminate\Http\Request;      
  
/*      
|--------------------------------------------------------------------------      
| API Routes      
|--------------------------------------------------------------------------      
|      
| Here is where you can register API routes for your application. These      
| routes are loaded by the RouteServiceProvider within a group which      
| is assigned the "api" middleware group. Enjoy building your API!      
|      
*/      
  
Route::middleware('auth:api')->get('/user', function (Request $request) {      
  return $request->user();      
});      
  
Route::get('/wechat', 'WechatAPIController@some-method');      
Route::post('/wechat', 'WechatAPIController@some-other-method');

api.php和web.php同處于routes文件夾下。

在api.php中添加的路徑，在訪問(wèn)時(shí)，我們需要在路徑前，加上api/前綴：

//chabaoo.cn/api/wechat

好了，這樣一來(lái)，我們就完成了API路徑的定義，或者換句話說(shuō)，取消了路徑的CSRF保護(hù)。

本文主要講解了Laravel框架定義API路徑取消CSRF保護(hù)的操作方法，更多關(guān)于Laravel框架的使用技巧請(qǐng)查看下面的相關(guān)鏈接

您可能感興趣的文章: