Swaggerに触れる
最近記事を書いていないことに気づいて慌てて書く。
「何だこのyaml？」から
業務で他プロジェクトのドキュメントをあさっていたところ、ExcelやWordのドキュメントを期待していたのに.yamlのファイルを2～3個発見。
どうやらAPIの定義が書いてあるようだが、テキストエディタで開いたままだと何が書いてあるのかさっぱりわからない。
で、担当の方に聞いたところ、Swaggerを使用して書いたものだという。
Swagger Editorを使ってファイルを開くと、なんかいい感じのドキュメントに見える！ナニコレー！
ということで、軽く調べて記事にする。
OpenAPIというもの
APIを記述したり文書化するためのオープンソースの書式だそうで。
もともとはSwagger仕様だったものが、OpenAPIとなり最新バージョンは3.0.0。
定義の記述はJSONまたはYAMLで記述可能。
おすすめはYAMLとのこと。
そもそもYAMLがよくわからん
Spring の教材の、設定ファイル関連の説明で見たけどそもそもどういうものなの？
ということで。
説明は上記リンクにあったのでざっくりと読んだ。
「"」とかそもそも書かずに済むやつなんですね。
業務で見たファイルは結構「"」入ってたなあ。
JSONやXMLと比較して読みやすいし、コメントも書けるしシンプル！ということのよう。
分量が少ないけど、今日はここまで。
