メメメモモ

プログラミング備忘録、リモートワーク生活、筋トレ、etc

RESTful API設計をする際に考慮する点

認証API

一覧取得API

以下のパラメータをリクエストパラメータとして指定できるようにしておく。

  • ページネーション系パラメータ
    • per_page (1ページごとの件数)
    • page (何ページ目のリストを取得するか)
  • フィルタ系パラメータ
    • enum系(status/typeなど)
    • フリーワード検索
  • ソート系パラメータ
    • order_by(どのカラムでソートするか)
    • desc/asc(降順/昇順)

一括更新

  • 一覧ページで一括更新
  • CSVで更新

ステータスコード(レスポンス)

以下のページで紹介されているダイアグラムを参考にすると良さそう。

www.agilegroup.co.jp