Postmanを使ってサクッとAPIを設計・モックを作ってみよう

​

​

API開発のベストプラクティスについて考えてみよう

スピーカー紹介：不破 崇行(ふわ たかゆき)

• 所属
• 昼(9:00〜18:00) / エコモット株式会社 平社員
• 夜(18:30〜23:00) / 合同会社 東雲研究所 代表社員
• やってること
• インフラ構築からアプリ開発、運用保守まで一式
• 普段使っているクラウド
• AWS / Azure / 最近はCloudflareも
• 趣味
• 飛行機
• ポータブルオーディオ

色々やっています

テック系イベントでの登壇を通じて、技術をわかりやすく説明しています

(Microsoft Build Japan 2023など)

https://www.youtube.com/watch?v=apQ-QE_nyig

今日のおはなし

• Postman初心者向けのお話です
• 「これからPostmanを触ってAPI開発をしてみたい」という方向け
• Postmanを使った、APIの設計からモック実装までをサクッとやる�内容です

​

• 「既にPostman使ってるよ！」という方は、�Postmanを社内で布教するテクニックとして参考にしてください！

そもそもAPIとは

• 簡単に言うと、サービスの「窓口」
• 例えば、「X(旧Twitter)から特定ユーザーのツイート一覧を取得する」など
• APIという、「窓口」を経由して情報を取得したり、ポストをする。
• それっぽく言うと、「インタフェース」
• 開発者向けに、サービスにアクセスするサードパーティーアプリを作ってもらうためにAPIを公開しているケースが多い。

X(Twitter) APIの例

API設計で重要なこと

• 相手のことを思いやった設計
• 「APIを使う相手は何なのか？」を考える
• 例えば、SPAとしてJavascript(Vue.jsなど)上で使用するAPIを設計するので�あれば、最小限のコール回数で目的を達成できるようにする。
• IoTデバイスなど、相手がハードウェアの場合、最小限の通信回数やペイロードで処理を実現できるようにすることで、バッテリーへの負担を減らす。

​

とにかく思いやりが、非常に重要です。

API設計で重要なこと

Googleがわかりみ深い事を書いているので、ぜひ読んでほしい。

https://cloud.google.com/blog/ja/products/api-management/restful-web-api-design-best-practices/

「サクッと」の条件

• 迷わず動ける
• 複雑な操作をしなくても出来る

​

• 目的を見失わずに進める
• 本来作りたいものを作れる

Postmanで実現できること

• ある程度設計を考えながら、APIを作ることが出来る
• しっかり設計するなら、OpenAPIでドキュメントを作ってから�Postmanにインポートしよう
• チームでそのままPostmanのワークスペースを共有出来る
• Postmanのインタフェースは難しくないので、割と直感的に作れる
• モックまで公開することが出来る

今日デモする内容

「簡単なAPIを考え、モックまで作る」

• 機能
• 特定地点の「お天気」を返してくれるAPI
• 地点は、パラメータで指定する

完成形

Postmanの画面

ブラウザで叩いてみた

まとめ

• システム開発は、「相手に対する思いやり」が重要
• 使う人に合わせたAPI設計や開発を目指そう