2016-05-06 24 views
4

私はWebApiプロジェクトでswaggerとswagger-uiの使用を可能にするためにSwashbuckleを使用しています。swagger-uiページにコントローラの名前を変更する方法はありますか?

次の画像では、swagger-uiページに表示されている2つのコントローラを確認できます。これらはC#コードのように名前が付けられていますが、ここに表示されているものを変更する方法があるかどうか疑問に思っていましたか?

これは主に、ManagementDashboardWidgetがユーザーフレンドリーな名前ではないため、ユーザーフレンドリーに変更したいからです。

swagger-ui

+0

静かなサービスクラスの注釈としてswaggerの@Apiを使ってみましたか? – Sampada

+0

@Sampada私はそれにアクセスする方法がわかりません。少し詳細を教えてください。 – XN16

+0

申し訳ありません@APIは、Javaのswaggerで使用できますが、swashbuckle swaggerでは使用できません。 – Sampada

答えて

6

あなたはそのためのタグを使用することができます。デフォルトでは、Swashbuckleはすべての操作にコントローラ名のタグを追加します。 SwaggerOperationAttributeで上書きすることができます。たとえば、次の行は、タグのテストで、デフォルトのタグ、値を置き換えます。

public class ValuesController : ApiController 
{ 
    [SwaggerOperation(Tags = new[] { "Test" })] 
    public IHttpActionResult Get() 
    { 
     // ... 
    } 
} 

Get動作について、グループTestに配置されます。

操作を複数のグループに表示する場合は、さらにタグを追加できます。例えば:

[SwaggerOperation(Tags = new[] { "Test", "Release1" })] 

はグループTestRelease1Get操作を配置します。

+0

それはまさに私が望んでいたものです...私はその部分について多くの文書を見つけたことはありません。どうもありがとう。 – XN16

関連する問題