2016-10-26 3 views
3

リクエストに必要な権限を文書化する方法はありますか?私はswagger - 許可の注釈?

[Authenticate] 
[RequiredRole("Admin")] 
[RequiredPermission("CanAccess")] 
public object Delete(DeleteAppUser deleteUserRequest) 
{ 
    // .... 
} 
私のサービスクラスで

または代わりに、私のRequestDTOsため

[Authenticate] 
[RequiredRole("Admin")] 
[Route("/appusers/{AppUserId}", "DELETE", Summary = "Delete an application user identified by its ID.")] 
public class DeleteAppUser : IReturn<AppUserDto> 
{ 
    // .... 
} 

が、私は自動的に私のAPIのユーザーのための闊歩-UIドキュメントで、これは何とか利用できるようにすることができたり、私が持っているかのような注釈を持っている場合ノートのように書く:

[Route("/appusers/{AppUserId}", "DELETE", Summary = "Delete an application user identified by its ID.", Notes="Requires an authenticated session and membership in the Admin role.")] 

答えて

2

No Swaggers UIには役割や権限の概念がありません。この情報はServiceStackの/metadata pagesに表示されますが、SwaggerのUIに表示するにはAPIのテキストの説明に追加する必要があります。