Web API チェックリスト

• URIが短く入力しやすいか
• URIが小文字のみで構成されているか
• URIにサーバ側のアーキテクチャが反映されていないか
• 適切なHTTPメソッドを利用しているか
• ページネーションは適切に設計されているか
• レスポンスのデータ形式はJSONがデフォルトになっているか
• データ形式の指定には、クエリパラメータを使う方法をサポートしているか
• レスポンスのデータ内容はクライアントから指定できるようになっているか
• レスポンスデータの構造は可能な限り、フラットになっているか
• レスポンスデータが配列ではなくオブジェクトになっているか
• バージョンで管理されているか
• APIが受け取るパラメータは、きちんと不正値をチェックしているか
• Rate Limitによる制限を行なっているか