swagger editor を趣味で活かす

by kanayannet

Slide 1

Slide 1 text

Swagger Editor を趣味で活かす @kanayannet Gunma.web #34

Slide 2

Slide 2 text

What's Swagger Editor

Slide 3

Slide 3 text

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

Slide 4

Slide 4 text

OpenAPI専用の最初のオープンソースエディタでAPIを設計、記述、文書化します。 Swagger Editorは、OpenAPIをすぐに使い始めるのに最適です。

Slide 5

Slide 5 text

大事なことなので OpenAPIをすぐに使い始めるのに最適です。

Slide 6

Slide 6 text

どうせやるなら日常生活の何かで試したい

Slide 7

Slide 7 text

部屋の温度のAPI

Slide 8

Slide 8 text

理由 2月に子供生まれます。

Slide 9

Slide 9 text

理由 2月に子供生まれます。部屋が寒すぎたり、暑すぎたりが怖い。

Slide 10

Slide 10 text

理由 2月に子供生まれます。部屋が寒すぎたり、暑すぎたりが怖い。出先でも知りたい。

Slide 11

Slide 11 text

システム構成ラズパイで温度を API へ post

Slide 12

Slide 12 text

No content

Slide 13

Slide 13 text

システム構成ラズパイで温度を API へ post API ‑> DB に部屋ごとにデータを書く

Slide 14

Slide 14 text

システム構成ラズパイで部屋ごとの温度を API へ post API ‑> DB に部屋ごとにデータを書く出先で端末からAPIへアクセスして部屋ごとの温度を得る

Slide 15

Slide 15 text

図

Slide 16

Slide 16 text

デモ

Slide 17

Slide 17 text

注意点(自分がハマったもの) docker 経由で使ったものは default https だった。 schemes: で指定すれば解決 docker 以外でもそうかも?(未検証) type: array の後ろは items items というキーのarray ではない。 POST の場合 name=xxxx のものは引数の定義があっても右のシュミレータで正しく値を渡してくれない場合がある。必要な設定 in: formData consumes: application/x‑www‑form‑urlencoded

Slide 18

Slide 18 text

まとめ今までフレームワークによってフォーマットが決まってないルーティングが存在する該当のフレームワークのルーティングを読めないと不安。例: rails: config/route.rb など swagger editor後 yaml という人間にやさしい定義書で見れそう。先行して client の作成を始めやすいか。