Fuseレッドハットでコンサルティングしているフェンです。今回は、swagger-uiをFuseアプリケーションに埋め込み、APIドキュメント(WebAPI仕様書)を簡単に公開するサンプルと設定内容を紹介します。定義されたAPIのAPIドキュメント(WebAPI仕様書)を表示します。ソースコードはGithub(https://github.com/jian-feng/camel-restdsl-swagger-demo.git)からダウンロードできます。APIのドキュメントや、サーバ、クライアントコード、エディタ、またそれらを扱うための仕様などを提供するフレームワークであります。Specificationから動的にドキュメントを生成するツールです。APIを記述するDSLです。APIを開発する方法は、これらの記事をご参照ください。サンプルの実行方法Mavenコマンドで実行します。UIの組み込みpom.xmlにSwaggerライブラリを追加します。configuration(camel-context.xmlの<restConfiguration>)に記述します。enableCORSは、Swagger有効化ため最低限の設定。他に設定可能な内容は、こちらを参照してください。<apiProperty>は、API情報(infoObject)の設定。他に設定可能な内容は、こちらを参照してください。context(camel-context.xmlの<rest>)に記述します。contextを別XMLで記述し、Camel-context.xmlにてincludeすることもできます。Swagger有効化ため最低限の設定。他に設定可能な内容は、こちらを参照してください。Coreのモデルプロパティ定義(@ApiModelProperty)アノテーションを使って、個々のDataModelに補足情報を追加します。用いて、プロパティの説明や入力例、プロパティの表示順序などを設定できます。以下は主要なメソッドを説明します。プロパティ名を指定します。プロパティが必須かどうかを指定します。プロパティの入力例を指定します。プロパティの表示順序を指定します。DSLで開発されるAPIはcamel-swaggerを介して、APIドキュメントを公開する方法を理解できたでしょうか。APIの開発時に、ソースコード上でコメントだけでなく、公開可能なAPI情報も意識して埋め込めば簡単に情報共有できます。このため、開発標準の一環として取り入れてください。HatでOpenShiftのサポートをしているid:nekopです。Hatソフトウェアエンジニアの佐藤匡剛です。Hatの佐藤匡剛です。Hatの佐藤匡剛です。各記事は著者の見解によるものでありその所属組織を代表する公式なものではありません。その内容については非公式見解を含みます。スターをつけました引用をストックしましたストック一覧を見る閉じる引用するにはまずログインしてくださいログイン閉じる引用をストックできませんでした。再度お試しください閉じる限定公開記事のため引用できません。