1、依存関係を追加:のpom.xmlにSwagger2依存関係を追加する最初:
<! - 闊歩依赖- > < 依存> < groupIdを> io.springfox </ groupIdを> < たartifactId > springfox-swagger2 </ たartifactId > < バージョン> 2.6.1 </ バージョン> </ 依存関係> <! - 用于生成在线文档的- > < 依存> < groupIdを> io.springfox </ groupIdを> < たartifactId >springfox-闊歩-UI </たartifactId > < バージョン> 2.6.1 </ バージョン> </ 依存関係>
図2に示すように、コントローラクラスの説明:
(1)は、データを格納するのに単純なエンティティクラスを作成します。
パブリック クラスブック{ // 属性 プライベート整数入札。 プライベート文字列のBNAME。 プライベート文字列のbprotagonist。 プライベート文字列のBTYPE。 パブリックブック(){ スーパー(); } 公共ブック(整数入札、文字列BNAME、文字列bprotagonist、文字列BTYPE){ スーパー()。 この .BID = 入札。 この .bname = BNAME。 この .bprotagonist = bprotagonist。 この .btype = BTYPE。 } パブリック整数getBid(){ 戻り入札。 } 公共 ボイドsetBid(整数入札){ この .BID = 入札。 } パブリック文字列getBname(){ 戻りBNAME。 } 公共 ボイドsetBname(文字列BNAME){ この .bname = BNAME。 } パブリック文字列getBprotagonist(){ 戻りbprotagonist。 } 公共 ボイドsetBprotagonist(文字列bprotagonist){ この .bprotagonist = bprotagonist。 } パブリック文字列getBtype(){ 戻りBTYPE。 } 公共 ボイドsetBtype(文字列BTYPE){ この .btype = BTYPE。 } @Override パブリック文字列のtoString(){ リターン "ブック[入札=" +入札+ "BNAME =" + BNAME + "bprotagonist =" + bprotagonist + "BTYPE =" + BTYPE + "]" 。 } }
(2)の効果を示すシミュレーションデータへの単純なコントローラを作成します。
リターン冊。 } / ** *添加 * @paramのブック * @return * / (@GetMapping "追加/" ) 公共ブックaddBook(書籍・ブック){ リターンブック。 } }
3、調製Swagger2構成クラス、スキャニングコントローラSpringMVC。
クラスの構成コードの大部分は固定されているが、コントローラが間違ったパッケージ名にすることはできませんが、必要なパッケージを導入し、自動的に推奨CTRL + SHITF + O {}のショートカットをコピーされます。
/ ** * Swagger2の設定クラス * / @Configurationは // 設定クラスと表記 EnableSwagger2 @ // また、ブートクラスに書き込まれたSwagger2アプリケーションを起動するための パブリック クラスSwagger2Config { @Bean 公衆整理番号createRestApi(){ // スキャンコントローラSwagger2ノートに、内部.apis指定されたパッケージのことを示し 、戻り 、新たな新ドケット(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .Select() // コントローラのパッケージ名 .apis(RequestHandlerSelectors.basePackage(「com.szc .controller " )) .paths(PathSelectors.any()) .build(); } // APIの説明 プライベートApiInfo apiInfo(){ 返す 新しい新ApiInfoBuilder() .TITLE( "SprignBoot統合sawgger2オンラインのAPIドキュメント") // タイトル .DESCRIPTION( "情報文書を記述する") // 説明 .termsOfServiceUrl( "https://baidu.com") // URL .version( "szc_1.0") // バージョン .build(); } }
4、アプリの起動クラスのSpringBootプロジェクトを開始します。
5、打ち上げ成功後、ブラウザのアドレスバーに、入力HTTP:// localhostを:8080 /威張っ-ui.html、あなたが見ることができます
コントローラ名を開く、あなたが見ることができる方法
層法により層を開け、この方法は、所望のパラメータまたは戻りデータを表示することができ