ChatGPTを使ってOpenAPIの定義を作成してモックサーバを立てる

こんにちは、エンジニアの黒岩(@kro96_xr)です。

はじめに

ChatGPT、流行ってますね。
openai.com

VSCodeの拡張を使ってコードレビューをしたり
qiita.com

SQLを書いてもらったり

ChatGPT、SQLを書くのに使えるな。
細かいテーブル定義を教えなくてもいい感じでやってくれた。 pic.twitter.com/CFjNHbKD9Y
— うぃすきー(ガブリアス)@12/30 13:00 タイコたき火ダンスアフタヌーン (@Whisky_shusuky) 2023年1月11日

上手く活用することで開発生産性が上がっていくのではないかと思っています。
実際、私も~~面倒な~~OpenAPIのymlファイルの記述などを書いてもらったりしています。
というわけで今回はChatGPTを活用してモックサーバを爆速で立てていきたいと思います。

なお、ChatGPTの使い方は割愛させていただきます。

また、ChatGPTに関する著作権を調べていたところ、商業目的での使用はNGのようでした。
ブログへの掲載も広義で見れば宣伝とも言え、グレーなのかもしれないと思っていますが、詳しい方がいらっしゃいましたらご教示いただけますと幸いです。

note.com

とりあえずTODOアプリのAPIを定義する

今回はサンプルなので設計からChatGPTに投げてしまいます。
実際に使う場合は、ドメイン知識を事前に教えたり、自身で作成した具体的なjsonのレスポンスを教えたりしてからお願いした方が良いです。

普通のCRUDのエンドポイントですね。ymlにしてもらいましょう。

出力されたファイルをyml形式で保存しておきます。
Swagger Editorにコピペすればドキュメント形式でも見ることができますね。

モックサーバを立てる

次に、保存したymlファイルからモックサーバを立てましょう。今回はdockerを使います。
公式で配布されているイメージを使って、yamlファイルを指定するだけです。

openapi.ymlと同じディレクトリに以下のようなdocker-compose.ymlを作って

version: "3"
services:
  mock:
    image: stoplight/prism:latest
    container_name: "prism-mock"
    ports:
      - "4010:4010"
    command: mock -h 0.0.0.0 /openapi.yml
    volumes:
      - ./openapi.yml:/openapi.yml

upコマンドでコンテナを立ち上げればOKです。

docker-compose up
prism-mock | [5:12:29 AM] › [CLI] … awaiting Starting Prism…
prism-mock | [5:12:30 AM] › [CLI] ℹ info GET http://0.0.0.0:4010/todos
prism-mock | [5:12:30 AM] › [CLI] ℹ info POST http://0.0.0.0:4010/todos
prism-mock | [5:12:30 AM] › [CLI] ℹ info GET http://0.0.0.0:4010/todos/404
prism-mock | [5:12:30 AM] › [CLI] ℹ info PUT http://0.0.0.0:4010/todos/657
prism-mock | [5:12:30 AM] › [CLI] ℹ info DELETE http://0.0.0.0:4010/todos/878
prism-mock | [5:12:30 AM] › [CLI] ▶ start Prism is listening on http://0.0.0.0:4010

これでモックサーバを立てることが出来ました。

GETも