この記事では、Swagger2をSpring Boot Projectで使用する例を紹介します。それはあなたと共有されます。詳細は次のとおりです。
swagger2依存関係を追加します
pom.xmlにswagger2依存関係を追加します
<Dependency> GroupId> io.springfox </groupid> <artifactid> springfox-swagger2 </artifactid> <version> 2.2.2 </version> </dependency> <dependency> <groupid> io.springfox </groupid> <artifactid> springfox-swox-verion </artificid>
Swagger2構成クラスを作成します
application.javaの同時レベルでswagger2の構成クラスswagger2を作成します。
Import.springframework.context.annotation.bean; import org.springframework.context.annotation.configuration; Import springfox.document.builders.apiinfobuilder; Import springfox.documentation.builders.builderectors; importfox.documentation.documentation.documentation. documentation. documentation. springfox.documentation.service.apiinfo; Import springfox.documentation.spi.documentationtype; Import springfox.documentation.spring.web.plugins.docket; Import springfox.documentation.swagher2.annotations.enableswagger2; createrestapi（）{return new docket（documenttytype.swagger_2）.apiinfo（apiinfo（））.select（）.apis（requesthandlerselectors.basepackage（ "独自の外部インターフェイスパッケージ名"）。 } private apiinfo apiinfo（）{return new apiinfobuilder（）.title（ "neo4j restful apis"）.description（ "the neo4j restful apis description/"）.termsofserviceurl（ ""）.contact（ "li qinghai"）。 }}ドキュメントコンテンツを追加します
上記の構成を完了した後、ドキュメントコンテンツは実際に作成できますが、そのようなドキュメントは主にリクエスト自体を対象としており、説明は主に関数やその他の関数の命名から来ていますが、これはユーザーフレンドリーではありません。通常、ドキュメントコンテンツを豊かにするための指示を追加する必要があります。
Io.swagger.annotations.apiをインポート; Io.swagher.annotations.apioperation; Import io.swagger.annotations.apiparam;/** *システムユーザーコントローラー * * @author li qinghai * */@api（value = "Systemユーザーインターフェイス"、タグ= "システム管理" usercontroller {@autowired private userservice userservice; /** *登録、登録 * * @param loginname * account * @param username * user name * @param password * @param roled * @return * @throws resourceexistsexception */@apioperation（value = "add user"）@postmapping（ "/"/" @apiparam（@apiparam" logiparam "logiparam" logiparam（ "logiparam） account "、required = true）@requestbody strue）@requestbody string loginname、@apiparam（name =" username "、value =" user name "、expened = true）@requestbody文字列ユーザー名、@apiparam（name =" prue = true string " @apiparam（name = "roleId"、value = "ユーザーロール番号"、必須= true）@RequestBody string roleid）throws resourceExistSexcection {boolean exists = this.userservice.exists（loginname）; if（exists）{新しいResourceExistSexcection（loginname）; } user user = userservice.create（loginname、password、username、roleid）; New JSonResult（ユーザー）を返します。 }}APIを表示します
スプリングブートプログラムを開始してアクセスしてください：http：// localhost：8080/swagger-ui.html
APIドキュメントアクセスとデバッグ
インターフェイス関数の表示に加えて、Swaggerはデバッグおよびテスト機能も提供します。上の写真の右側にあるモデルスキーマ（黄色の領域：データ構造を示す）をクリックできます。この時点で、値にユーザーオブジェクトのテンプレートがあります。わずかに変更するだけで、[以下で試してみてください]をクリックしてください！ボタン、リクエストコールを完了できます！いくつかのGETリクエストを使用して、以前のPOSTリクエストが正しいことを確認できます。
上記はこの記事のすべての内容です。みんなの学習に役立つことを願っています。誰もがwulin.comをもっとサポートすることを願っています。