2016-06-28 8 views
2

私が闊歩してAPIを作成すると、normaly私のAPIは、リソースの名前を持っていますSwagger-ui api(リソース)の名前はどのように生成されますか?

Tasks 
/tasks 
/tasks/{id} 
etc. 

時々私は唯一のデフォルトを得る:生成されたAPIのヘッダ名を決定するもの

Default 
GET /tasks 
GET /tasks/{uuid} 
etc. 

?望んだ行動の

スクリーンショット(タスクが時々デフォルトです):

enter image description here

答えて

4

Swagger UIでこれらのヘッダーを意味していますか?

headers

彼らはあなたのAPI操作のtagsに基づいて生成されます。たとえば、[タスク]の操作をグループ化するには、次のように指定します。

{ 
    ... 

    "paths": { 
    "\/tasks:": { 
     "tags": [ 
     "Tasks" 
     ], 
     ... 

各操作には任意の数のタグを設定できます。タグのない操作は、「デフォルト」グループの下に表示されます。

トップレベルtagsセクション使用、タグの説明を提供する:

{ 
    ... 

    "tags": [ 
    { 
     "name": "Tasks", 
     "description": "Operations to manage tasks" 
     } 
    }, 
    { 
     "name": "Notes", 
     "description": "Operations to manage notes" 
     } 
    } 
    ], 
    ... 
2

これは、あなたのRESTfulなサービスの実装の上部に闊歩のAPI注釈(io.swagger.annotations.Api)への引数として渡されているかに依存します -

@Path(value="/") 
@Api(value="/") 
public interface YourService { 
    .... 
} 

@Api(value="/")が生成されますdefault

@Api(value="/Tasks")が生成されますTasks

関連する問題