SpotlightSudioの導入
Yaml自動生成支援ソフトを利用する。
パラメーターを入力するとYamlを自動生成してくれます。
New Open APiから新規作成
アクセストークがいらないPublicApiを利用します
ttps://public.api.nicovideo.jp/v1/channel/channelapp/content/videos.json?page=1&channelId=2645675&sort=startedAt
New Open Apiから新規に作成する
左上のyamlをダブルクリックすると表示される。APIとEndPointをクリック
APIOverViewでベースURLを設定します
エンドポイントの作成
パスURLの最後とパラメーターを入力する
モデルの作成
Jsonを貼り付けることでモデルが作成される
モデルとエンドポイントのレスポンスを紐付ける
エンドポイントのレスポンスとモデルを紐付ける
$refボタンを押すことでmodelをリファレンスする
$refボタンを押してmodelを検索する
Yamlを書き出す
右クリックからExport
RiderにOpenApiのプラグインの導入
Yamlのエディタ、プレビューが利用可能に
SwaggerCodeGenの実行環境をウィンドウから設定できるようになる
プラグインの導入
RiderにOpenApi支援プラグインをインストールします
yamlファイルをクリックするとプレビューとエディタが利用可能に
プラグインを入れた状態だと実行構成にSwagger Codegenのテンプレートが表示される
実行構成にパスを設定する
仕様書パスにYamlファイルのパス
ファイルの生成場所を設定する
ジュネレーターパスはswagger codegenのソースをmavenがビルドしてバイナリにしてダウンロードしてくれます
codegenジェネレーターのテンプレートはバージョンによって違います
コードの生成
設定が完了すると実行ボタンが表示される
Yamlファイルの上にも生成ボタンが表示される
ボタンを押すとAPIクライアントを生成してくれます
書き出されたAPIクライアント Org.OpenAPIToolsの使用例
OpenApi Generater 5で書き出すとOrg.OpenAPIToolsプロジェクト一式が書き出されます。
書き出されたプロジェクトファイルを作業しているExploerの同じ階層に読み込みます。
dllを参照する感じでAssmblyのところで右クリックでOrg.OpenAPIToolsプロジェクトを参照します。
課題
codegenジェネレーターで書き出されるAPIクライアントはいろいろあるので比べてみる必要がある。
APIクライアントで２度目以降書き出さなくてよいファイルを隔離しないといけない