スタイル安らかなAPIのスタイルテン仕様インタフェース

• インターフェースは、ビューの方法の複数を使用することなく、制御機能と同様の機能の動作の異なる方法を使用し
• 推奨される使用httpsで通信するためのAPIユーザー
• URL仕様
  • サブドメインを区別するために（クロスドメインこのような問題になりやすいです）
    • www.fandx.comを使用したフロントエンドのドメイン名
    • api.fandx.comを使用してバックエンドのドメイン名
  • 区別するためのURLの方法（非常にシンプルに実現することができます）
    • フロントエンドwww.fandx.com
    • バックエンドwww.fandx.com/api
• 版
  • www.fandx.com/api/v1/
• インターフェース名（名詞）
  • www.fandx.com/api/v1/名詞
• 方法フォーム
  • GETクエリ
  • 投稿を追加
  • 更新されたリソースサーバ（変更後のクライアントが提供する完全なリソース）を置きます
  • サーバ内の（プロパティを変更するには、クライアントによって提供された）パッチ更新リソース
  • サーバーから削除リソースを削除
• フィルタリング、音声パラメータを送信することにより、URLの検索条件をアップロード
  • ？リミット= 10を指定し返されたレコードの数
  • ？オフセット=開始位置への復帰は、10のレコードを指定しました
  • ？ページ=、および2ページ＆PER_PAGE = 100を指定し、最初の数ページあたりのレコード数を
  • ？SORTBY =名＆オーダー= ASCソートして結果を返すようにするプロパティを指定し、ソート順
  • ？Animal_type_id = 1つの指定したフィルタ条件
• ステータスコード
  • 200の成功
  • 300リダイレクト
  • 400クライアントエラー
    • 401ユーザーは、許可トークンを持っていません
    • 403は、登録利用者が、アクセスは禁止されています
    • 404のアクセスリソースが見つかりません
  • 500内部サーバーエラー
• キー勧告エラーとして返されるエラー
• 結果へ戻ります
  • 取得/コレクションは、リソースのリストを返します。
  • 取得/コレクション/リソースは、単一のリソースオブジェクトを返します。
  • ポスト/コレクションは、新世代のためのリソースオブジェクトを返します。
  • PUT /コレクション/リソースは、完全なリソースオブジェクトを返します。
  • パッチ/コレクション/リソースは、完全なリソースオブジェクトへの部分的復帰を修正します
  • 削除/コレクション/リソースは、空のドキュメントを返します。