序文
前のブログでは、サービスをユーレカに登録しました。 EurekaのUIインターフェイスから、どのサービスがEureka Serverに登録されているかを見ることができます。ただし、現在のサービスによってどのRestfulインターフェイスメソッドが提供されているかを確認したい場合は、それらを取得する方法がありません。従来の方法は、開発者間の通信のためのサービスインターフェイスドキュメントを整理することです。この場合、多くの場合、コードが変更されているなど、ドキュメントとコードの間に矛盾を引き起こしますが、インターフェイスドキュメントは変更されておらず、Swagger2は完璧なソリューションを提供します。 Swagger2が問題をどのように解決するかを見てみましょう。
1。Swagger2が依存しているJARパッケージを紹介します
<！ - swagger2-> <dependency> <groupid> io.springfox </groupid> <artifactid> springfox-swagger2 </artifactid> <バージョン> 2.2.2 </version> </dependency> <dependency> io.springfox </groupid> springfox-swagh-uuidid> <バージョン> 2.2.2 </version> </dependency>
2。swagger2の構成を初期化します
@configuration @enableSwagger2 // swagger2 public class swagger2 {@bean public docketerestapi（）{// API基本情報を作成する新しいドケットを返す（documenttationtype.swagger_2）.apiinfo（apiinfo（））.apis（）apis（）apis（）japackage（）com.phasepackage（） @apiignore annotation annotated.path（pathselectors.any（））.build（）を除き、Swaggerで表示する必要があるこのパッケージの下のすべてのAPIをスキャンします。 } private apiinfo apiinfo（）{// Swagger UIに表示されるAPIの作成に関する基本情報。新しいapiinfobuilder（）.title（ "swagger2を使用してスプリングブートで安らかなapiをビルド）// api title.description（" RDCloud-jpa "によって提供されるRESTFUL API）// API Description.Contact（" chhliu@"）// contact.version（" 1.0 "）//バージョン番号。Build（）; }}注：この構成クラスは、同じレベルのアプリケーションディレクトリに作成する必要があります。プロジェクトが開始されると、構成クラスが初期化されます。
3。APIドキュメント情報を改善します
パブリックインターフェイスSonarControlleri {@Apioperation（value = "プロジェクトグループのソナーに対応するURL情報を取得"、notes = "IDに基づいてプロジェクトグループのソナーに対応するURL情報を取得します"） 「long」、paramtype = "path"）}）//この注釈を使用して、メソッドパラメーター情報を説明します。ここでは、パラマタイプパラメーターをパスとして構成する必要があることに注意する必要があります。そうしないと、UI @getMapping（ "/get/{id}"）Sonarurl get（@pathvariaiable long id）のインターフェイスメソッドにアクセスするときにエラーが報告されます。 @apioperation（value = "プロジェクトグループSonarに対応するすべてのURL情報を取得"）@getMapping（ "/get/all"）list <Sonarurl> getAll（）; }注：paramtypeはパラメーターのタイプを表し、オプションの値は「パス」、「ボディ」、「クエリ」、「ヘッダー」、「フォーム」です。
4。返品タイプ情報を改善します
@Entity（name = "Sonar_url"）パブリッククラスSonarurlはSerializable { / ** * * / private static final long serialversionuid = 1l; @apimodelproperty（value = "primary key"、hidden = false、notes = "primary key、hidden"、必須= true、datatype = "long"）//この注釈を使用してプロパティ情報を説明します。 Hidden = trueの場合、このプロパティはAPI @id @generatedValue（Strategy = GenerationType.auto）に表示されません。 @apimodelproperty（value = "url linkアドレス"）@column（name = "url"）private string url; @apimodelproperty（value = "Project Group"）@column（name = "Team"）private string team; @apimodelproperty（value = "department"）@column（name = "department"）private string department; ... Getter、Setter Methodを省略します...}5。アプリケーションを開始します
1。ブラウザに入力：http：// localhost：7622/swagger-ui.html
2。結果は次のとおりです。
6。APIドキュメントアクセスとテスト
Swaggerは、APIインターフェイス表示機能の提供に加えて、デバッグおよびテスト機能も提供します。
テスト結果は次のとおりです。
上記はこの記事のすべての内容です。みんなの学習に役立つことを願っています。誰もがwulin.comをもっとサポートすることを願っています。