萌えハッカーニュースリーダー

2025/09/12 14:53 Oq: Terminal OpenAPI Spec Viewer

出典: https://github.com/plutov/oq
hakase
博士

やあ、ロボ子!今日はターミナルでOpenAPI Specを見るツール、oqについて話すのじゃ!

roboko
ロボ子

OpenAPI Specをターミナルでですか?それは便利そうですね、博士。

hakase
博士

そうじゃ!`oq openapi.yaml`とか、パイプで`cat openapi.yaml | oq`って感じで使うみたいじゃな。API定義をサッと確認したい時に便利だぞ。

roboko
ロボ子

`curl`で直接API定義を渡せるのも良いですね。`curl https://api.example.com/openapi.json | oq` ですか。

hakase
博士

その通り!キーボードショートカットも充実しておる。`↑/↓`や`k/j`で移動、`Tab`でエンドポイントとコンポーネントを切り替え、`Enter`や`Space`で詳細の折りたたみ/展開じゃ。

roboko
ロボ子

基本的な操作はカバーされているようですね。終了は`q`か`Ctrl+C`ですか。

hakase
博士

そうじゃ!OpenAPI 3.0.xと3.1.xに対応していて、JSONとYAML形式をサポートしておる。これはなかなか優秀じゃな。

roboko
ロボ子

対応バージョンが広いのは嬉しいですね。インストールはソースからビルドするみたいですね。

hakase
博士

`git clone`して`cd oq`、そして`go build -o oq`じゃ。簡単じゃな!

roboko
ロボ子

ライセンスはMIT Licenseですね。気軽に試せそうです。

hakase
博士

テストも忘れずに行うのじゃ。`go test -v`で確認できるぞ。

roboko
ロボ子

OpenAPI 3.0と3.1の両方の例でテストするのは重要ですね。博士、oqはなかなか便利そうですが、GUIがない分、とっつきにくいと感じる人もいるかもしれませんね。

hakase
博士

確かにそうかもしれん。でも、ターミナル好きにはたまらないツールじゃろうな。それに、リモート環境で作業するときとか、GUIが使えない状況では重宝するはずじゃ。

roboko
ロボ子

なるほど、そういうことですね。博士、今日はありがとうございました。

hakase
博士

どういたしまして。最後に一つ、oqを使うとAPIドキュメントがスッキリ見えるからって、見惚れすぎてコード書くのを忘れちゃダメだぞ!

⚠️この記事は生成AIによるコンテンツを含み、ハルシネーションの可能性があります。

Search