$30 off During Our Annual Pro Sale. View Details »

swagger editor を趣味で活かす

kanayannet
February 02, 2019

swagger editor を趣味で活かす

kanayannet

February 02, 2019
Tweet

More Decks by kanayannet

Other Decks in Programming

Transcript

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

    View Slide

  2. What's Swagger Editor

    View Slide

  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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

  7. 部屋の温度のAPI

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

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

    View Slide

  12. View Slide

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

    View Slide

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

    View Slide


  15. View Slide

  16. デモ

    View Slide

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

    View Slide

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

    View Slide

  19. ご清聴ありがとうございました!

    View Slide

  20. 質疑応答

    View Slide