【初心者向け】はじめてのWebアプリケーション開発 設計 API設計

はじめに

　Webアプリケーション開発のAPI設計で私が行ったことについてまとめます。
　私は、設計の中ではAPIの設計に一番時間がかかりました。

APIとは何か

　アプリケーションを開発したことがない方は、そもそもAPIとは何か、で躓くと思います。私も開発のために勉強するまで、きちんと理解できていませんでした。
　以下の参考記事がとても分かりやすかったです。

参考記事
・APIがわからない方向けに、具体例付きでわかりやすく解説！【実際にプログラミング】

API設計の流れ

以下の流れで作業しました。

1. APIについて調べる
2. 設計する

実施した作業

設計はstoplight studioを用いて実施しました。
簡単にyaml形式で設計ができるので、おすすめです。
https://stoplight.io/solutions

まとめ

APIについて解説をじっくり読むよりも、簡単に目を通して実際に作ってみる方が理解が進むと感じました。

・API設計の基本原則・手順
・Web API 設計入門
・SPA開発におけるWeb API設計入門（エンドポイント編）
・[RESTful API]パスパラメータ、クエリパラメータ、リクエストボディの違いと設計