swagger editor を趣味で活かす

Transcript

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