7/18.log

日曜日はゆっくりswagger

今日は日曜日なのでコードはほとんど書かずゆっくりしていました。ゆっくりする中でもswaggerでドキュメントを書いていました。

最初はswagger-editorをdockerで立ち上げ書いていたのですがエラー祭りで作業が進まない＋書き方がそもそもわからないでほとんど進みませんでした。流石に文法を勉強するのはめんどくさいので色々検索をした結果stoplight studioというエディタがあることを知ったので早速ダウンロードして使ってみました。ところどころ操作の方法がわからないようなところがありましたがなんとか完成まで持っていきました。

次にドキュメントをわかりやすくしたかったのでredocを使ったドキュメントの生成を行いました。docker化をしてからビルドコマンドや生成コマンドが長いと感じたのでmakefileを使って簡略化していました。

最終的には編集→stoplight studio、閲覧・確認→redocでいきたいと思っています。dockerに関してはredocの生成を行う時のみ使っていますがmakefileを使っているのでdockerコマンドを自分で打つことはないです。

快適な環境を作ることができました！

swaggerの文法難しいよな

swaggerの文法って思った以上に難しくないですか？難しいというよりかは覚えようともしていないというのが実際のことだと思いますが。ある程度使いこなせる人ならswagger-editorのみで簡単に記述できるんですかね？

ただapiの数が多くなり一つのファイルでは管理が難しくなる→分割の必要が出てくるとなるとそれこそstoplight studioといったGUIエディタを使わないと人間の力では管理できなさそうですよね。

sampleなどの詳細を書いていたらapiの数が少なくとも1000行行くとか聞いたんですが。