インタフェース要求パラメータの定義方法

791 ワード

リクエスト方式はいろいろありますが、統一のため、現在すべてのインタフェースの定義がPOST方式となっているため、restfulの定義を完全に守らないが、いくつかのメリットもあります.

は、パラメータを一定に保護することができる

は、GET要求パラメータ長の制限

を超えることを回避することができる.

インタフェース定義はいずれもできるだけ1つの単語で構成されており、複数の単語が出現した場合には、中線-によって分割される.Javaのアルパカネーミングは使用しません.

インタフェーストラフィックパラメータは、単純なタイプであり、3個未満の場合、application/x-www-form-urlencoded方式を用いて受け入れられる.複雑なオブジェクトタイプであれば、application/jsonを使用して手を放して受け入れます.

のいくつかの共通パラメータ、例えば 、、ip はHTTPのHeaderの中に置いて、ビジネスインタフェースのパラメータと混同しないでください.

パブリックリクエストパラメータの概要

デバイスid

ユーザ認証

端末タイプid

要求一意フラグ(traceid|spanid)

地理情報(経度|緯度)

クライアント時間

インタフェースが存在するページ名