Swagger Editor を趣味で活かす@kanayannet Gunma.web #34
View Slide
What's Swagger Editor
Design, describe, and document your APIon the first open source editor fullydedicated to OpenAPI‑based APIs. TheSwagger Editor is great for quickly gettingstarted with the OpenAPI
OpenAPI専用の最初のオープンソースエディタでAPIを設計、記述、文書化します。Swagger Editorは、OpenAPIをすぐに使い始めるのに最適です。
大事なことなのでOpenAPIをすぐに使い始めるのに最適です。
どうせやるなら日常生活の何かで試したい
部屋の温度のAPI
理由2月に子供生まれます。
理由2月に子供生まれます。部屋が寒すぎたり、暑すぎたりが怖い。
理由2月に子供生まれます。部屋が寒すぎたり、暑すぎたりが怖い。出先でも知りたい。
システム構成ラズパイで温度を API へ post
システム構成ラズパイで温度を API へ postAPI ‑> DB に部屋ごとにデータを書く
システム構成ラズパイで部屋ごとの温度を API へ postAPI ‑> DB に部屋ごとにデータを書く出先で端末からAPIへアクセスして部屋ごとの温度を得る
図
デモ
注意点(自分がハマったもの)docker 経由で使ったものは default https だった。schemes: で指定すれば解決docker 以外でもそうかも?(未検証)type: array の後ろは itemsitems というキーのarray ではない。POST の場合name=xxxx のものは 引数の定義があっても右のシュミレータで正しく値を渡してくれない場合がある。必要な設定in: formDataconsumes: application/x‑www‑form‑urlencoded
まとめ今までフレームワークによってフォーマットが決まってないルーティングが存在する該当のフレームワークのルーティングを読めないと不安。例: rails: config/route.rb などswagger editor後yaml という人間にやさしい定義書で見れそう。先行して client の作成を始めやすいか。
ご清聴ありがとうございました!
質疑応答