ServiceStack路線和動詞

Question

我試圖在我們爲業務創建的服務中建立編碼模式（一些規則）。 我們遵循apigree爲設計RESTful服務而制定的基本指導。

我們希望採用的規則之一是阻止我們不想支持的某些路線和動詞組合。據推測我們會發回一個HttpStatusCode.NotSupported這些非法的組合，也許是一個人類可讀的消息？

我們也希望支持的法律連擊是：

GET /resource - lists all resources 
GET /resource/{id} - retrieves specific resource by ID 
POST /resource - adds a new resource 
PUT /resource/{id} - updates specific resource by ID 
DELETE /resource/{id} - deletes specific resource by ID 

有一些非法的連擊我們明確地不想支持。

POST /resource 
PUT /resource 
DELETE /resource 

我們對每個支持的路由都有驗證器。 但我們沒有任何在我們的代碼庫中定義的非法路由。

從測試中，我們已經瞭解到，如果客戶端發送一個請求GET /resource/{id}一個空白ID（的String.Empty），然後ServiceStack魔不執行驗證該請求（GET /resource/{id}），而是重定向到GET /資源。我們認爲DELETE /resource/{id}和PUT /resource/{id}的確如此。但是，這些'默認'行爲都不是可取的，我們寧願要返回一個HttpStatusCode.NotSupported或者一些標題指向客戶端的API文檔（或一些這樣的指導）。

你能否建議一些選項來在框架中明確地處理這些情況？

歡呼

Answer 1

如果只想允許某些調用約定比你應明確在你允許與路由定義，如：

[Route("/resource", "GET")] 
public class GetAllResources {} 

[Route("/resource/{Id}", "GET")] 
public class GetResource 
{ 
    public int? Id { get; set; } 
} 

[Route("/resource", "POST")] 
public class CreateResource { ... } 

[Route("/resource/{Id}", "PUT")] 
public class UpdateResource 
{ 
    public int Id { get; set; } 
    ... 
} 

[Route("/resource/{Id}", "DELETE")] 
public class DeleteResource 
{ 
    public int Id { get; set; } 
    ... 
} 

比你的服務只匹配的動詞你「VE規定：

public class ResourceServices : Service 
{ 
    public object Get(GetResources request) { ... } 
    public object Get(GetResource request) { ... } 
    public object Post(CreateResource request) { ... } 
    public object Put(UpdateResource request) { ... } 
    public object Delete(DeleteResource request) { ... } 
} 

什麼是不匹配的將只是一個404 NOTFOUND，因爲有n o匹配處理請求的路由。

否則，您可以根據需要創建的服務，專門捕獲非法請求，並善待他們，e.g：

[Route("/resource", "DELETE PUT")] 
public class IllegalActions {} 

public class ResourceServices : Service 
{ 
    public object Any(IllegalActions request) 
    { 
     return new HttpError(HttpStatusCode.NotAcceptable, "ActionNotSupported"); 
    } 
} 

的Error Handling wiki在顯示所有可用的ServiceStack錯誤定製做得很好。能夠映射C＃例外HTTP狀態代碼也可能是有用的位置：

SetConfig(new HostConfig { 
    MapExceptionToStatusCode = { 
     { typeof(NotImplementedException), (int)HttpStatusCode.NotAcceptable }, 
     { typeof(NotSupportedException), (int)HttpStatusCode.NotAcceptable }, 
    } 
});