40代ママ、駆け出しエンジニアになりたい 〜API編〜#3

APIを使うのに、中身が知りたい！ってなったので。
エンジニアさんに相談したところ、Swaggerエディタでみてください... とのお話しをされまして。

(。´･ω･)ん?　だったので、調べてみました。

Swaggerとは...

OpenAPIを用いてREST APIを設計する際に使用するツールセットのこと　らしい。

OpenAPI：REST APIを記述する為の仕様
REST API(RESTful API)：URL + HTTPメソッドでリソースへアクセスするAPIのこと

        このサイトが優しく教えてくれてそうでした。

【簡単に】REST APIとは？初心者もわかりやすく解説

Swaggerツールセット？

Swagger Editor:ブラウザ上でAPI仕様書を書くためのエディタ
Swagger UI:API仕様書からドキュメントを生成するツール
Swagger Codegen:サーバー/クライアントのコードを生成するツール

がメジャーのようです。
今回自分が使うのは、Swagger Editorなので、こちらもうちょっとみていこうと思います。

Swagger Editorとは...

Swaggerの仕様にしたがってYAML(JSON)ファイルを編集するためのエディタのこと。

どうもインストールしなければならないのでとまどっていたら、VScodeからみるといいよと教えてもらったので、VScodeの拡張機能をインストールすることにしました。

Swagger Editor インストール...（VScode編）

サイドバーのEXTENSIONSを選択し、「Swagger Viewer」を検索する。

自分の場合は、APIのyamlファイルは作成していただいていたので、それをみることができれば一旦OKです。

・yamlファイルを開く
・Shift+Alt+p　または、表示→コマンドパレット　Preview Swaggerを選択

イメージでは、こういう感じでみることができました。

うーん、ほんとにすべてが未知すぎて。。
浅い知識しかいれれないけど、一旦よしで突き進みます
ヽ(･∀･ヽ) ﾜｯｹ!! (ﾉ･∀･)ﾉ ﾜｯｶ!! ヽ(･∀･)ﾉﾗﾝ!!