SpringBoot研究ノート：闊歩は、文書管理を実装

濶歩

　　闊歩は完全な仕様とフレームワークで生成、説明のため、および可視化は、RESTfulなWebサービスの呼び出します。SWAGGERの目標は、標準のREST APIと言語に依存しないインタフェースを定義することで、あなたがすることができ、コンピュータを聞かせて、ソースコードにアクセスする必要がない、文書、またはネットワークトラフィックを監視するには、サービス機能を発見し、理解することができます。

闊歩統合文書管理API

プロジェクトの統合闊歩

　　最初はの依存闊歩を追加することです。

<！ -威張っスプリング・ブート・スターター- > 
<依存> 
    <groupIdを> com.spring4all </ groupIdを> 
    <たartifactId>威張っスプリング・ブート・スターター</たartifactId> 
    <バージョン> 1.9.0.RELEASE < /バージョン> 
</依存関係>

　　その後、次のように、EnableSwagger2Doc注釈起動クラスオープン闊歩@追加します。

@ EnableSwagger2Doc 
@SpringBootApplication 
パブリッククラスのアプリケーション{ 

    パブリック静的無効メイン（文字列[] args）{ 
        SpringApplication.run（CodeHelperApplication.class、引数）。
    } 
}

ドキュメントを生成するために闊歩を使用して、

　　闊歩は、対応するAPIアノテーションによって生成され、我々のような、様々なインターフェースを記述するためにアノテーションのインターフェイスを追加する必要があります

    @ApiOperation（値= "查找城镇列表"）
    @ApiResponses（{@ ApiResponse（コード= 200、メッセージ= "OK"、応答= String.class）}）
    @RequestMapping（値= "getTownInfoList.do"、方法= RequestMethod .POST）
    公共一覧<文字列> getTownInfoList（）{ 
        しようと{ 
            studentMapper.getListGroup（ "stu_town"）を返します。
        }キャッチ（例外e）{ 
            e.printStackTrace（）; 
        } 
        はnullを返します。
    }

　　ここでは、2つのノートを使用します。

方法で使用@ApiOperation、方法の操作、インタフェースは、ノート情報を詳細に説明することができる属性を追加します。
方法で使用@ApiResponses、いくつかの命令に応答して、インターフェースに関する情報; @ApiResponsesは異なる応答コードに応じて異なる情報を設定するために、複数の@ApiResponseをカプセル化します。

オンラインテストインタフェース

ポート/威張っ-ui.html：サーバーアドレスは次のよう闊歩サービスにアクセスするために、そのインターフェイスは次のとおりです。

　　今説明した方法を見つける、あなたがインターフェイスの詳細を表示し、インターフェース呼び出しを試すことができます。　　

闊歩コメント

　　このセクションでは、ノートのいくつかは、上記で紹介し、共通のインタフェース文書は、言うことはありません生成された説明します

@Api

　　クラスでは、クラスの役割を説明しました。

@Api（タグ= { "学生情報インタフェース"}）
@RestController 
パブリッククラスStudentController { 
  ...   
}

@ApiModel

　　クラスでは、クラスがパラメータを説明する表します。

@ApiModel（値= "com.ms.qiandao.model.StudentModel"、説明= "新增用户参数"）
パブリッククラスStudentModel { 
    プライベート整数stu_id。
    プライベート文字列stu_name。
    プライベート文字列stu_sex。
    ...   
}

@ApiModedlProperty

　　フィールドで使用される、クラスのパラメータフィールドを説明する表します。

@ApiModel（値= "com.ms.qiandao.model.StudentModel"、説明= " ユーザパラメータを追加"）
publicクラスStudentModel { 
    @ApiModelProperty（値= "学生ID"）
    プライベート整数stu_id; 
    @ApiModelProperty（値= "学生名"）
    プライベート文字列stu_name; 
    @ApiModelProperty（値="学生のセックス「）
    プライベート文字列stu_sex; 
    ...   
}

@ApiParam

　　プロセスパラメータのためのコントローラを説明します。

@RequestMapping（ "cancel.do"）
公衆RegisterCode getById（@ApiParam（値= "学生ID" =真）整数ID必要）{ 
   ... 
}

@ApilmplicitParamと@ApilmplicitParams

　　この方法のために、別個のリクエストパラメータとして示され、そして@ApiParam同様の、しかし上記の方法で記述されています。

参考資料

「春のクラウドマイクロサービス、戦闘と実践」
https://swagger.io/tools/swagger-ui/