Upgrade to Pro — share decks privately, control downloads, hide ads and more …

microCMS × OpenAPIで高速かつ安全な開発を行う話

microCMS
April 22, 2022

microCMS × OpenAPIで高速かつ安全な開発を行う話

2022年4月21日に行われた microCMS Online Meetup の発表資料です。
https://microcms.connpass.com/event/240629/

発表のアーカイブをYouTubeで公開しています。こちらもあわせてご覧ください。
https://www.youtube.com/watch?v=2BBsCR1Mop8&t=3540s

microCMS

April 22, 2022
Tweet

More Decks by microCMS

Other Decks in Programming

Transcript

  1. 目次 2 • そもそも OpenAPI とは? • microCMS の OpenAPI

    連携機能の紹介 • microCMS の API の未来について #microcms_meetup
  2. 目次 4 • そもそも OpenAPI とは? • microCMS の OpenAPI

    連携機能の紹介 • microCMS の API の未来について #microcms_meetup
  3. そもそも OpenAPI とは? • RESTful API の仕様を表現するための仕様 • 言語非依存 &

    機械可読 (JSON or YAML) • 人間に優しいフォーマットにも変換できる 5 #microcms_meetup
  4. OpenAPI を使うメリット • 曖昧さが無い • 「foo が空になる」とは? ◦ {“foo”: “”}

    なのか? ◦ {“foo”: null} なのか? ◦ {} なのか? 20 #microcms_meetup
  5. OpenAPI を使うメリット • 豊富なエコシステムと連携できる • コード生成 (openapi-generator など) • ドキュメント生成

    (Swagger UI, ReDoc, RapiDoc) • モックサーバ生成 (Prism) • 自動バリデーション (committee-rails, express-openapi-validator) • GUI エディター (Stoplight Studio) 21 #microcms_meetup
  6. 目次 22 • そもそも OpenAPI とは? • microCMS の OpenAPI

    連携機能の紹介 • microCMS の API の未来について #microcms_meetup
  7. 目次 30 • そもそも OpenAPI とは? • microCMS の OpenAPI

    連携機能の紹介 • microCMS の API の未来について #microcms_meetup
  8. API v2 を開発中 • よりキレイな API に • OpenAPI と自動バリデーションを活用してより堅牢な

    API に • OpenAPI 連携機能は API v2 から提供される予定 31 #microcms_meetup
  9. マネジメント API を強化 • コンテンツ API 同様に RESTful な API

    として提供予定 • 管理画面で出来ることはなんでも API でも出来るように 33 #microcms_meetup
  10. マネジメント API として提供されるもの • 例) メディアの検索、アップロード、削除 • 例) API スキーマの

    CRUD ◦ OpenAPI 以外のアプローチでコード生成 ◦ 逆に TypeScript から API スキーマ生成 • 例) レビューの CRUD ◦ 放置されたレビューを Slack でリマインド 34 #microcms_meetup