APIインタフェースの設計上の考慮事項

インターフェイスのデザインは、それが困難な事象である、簡単な作業です。インタフェースのみんなのデザインは、誰もが結果のインタフェースにアイデアの多種多様を設計するだけでなく、することができます。非常に多くの年のための仕事は、私も非常に感情です。多くの人々は、限り名前が良いですと、その後、FBIを通じて、オンラインあなたがライン上でどのようにシンプルなインターフェイスのデザインを呼び出すことができる、と言うだろう。特に、非インターネット業界の人々は、何の差別がないことを意味します。インターネット業界や伝統産業であまりにも多くの矛盾がこのアイデアを生み出すことにしましたので。

 

インターフェイスは、ユニット内のプロジェクトの最小サイズで、インターフェイスのデザインがポイントに多くの注目を必要とし、注意を払っていない多くの人々のすべての側面のニーズを考慮しますが、インタフェース技術スタックの設計は、完全に人間の知識や技術の幅広さを調べることができるように、必要性の多くを必要と深さ。ここでは仕事でいくつかの概要を探検するあなたと一緒に交換することを期待して、です。

 

まず、インターフェイスバージョンの

    生産環境がある場合なしバージョン管理の変更は、コール・インタフェースになりません当事者は、変化に追随していないシステムがエラーになり、ユーザの経験に影響を与えているとそれが作ると仮定して、頻繁にフォローの変更をステークホルダーシステム全体の動作が困難ドッキングインターフェースが増加していきます、不利です。

    あなたがインターフェイスのバージョンをお持ちの場合は、ビジネス・ロジックの古いバージョンをリリースし、プログラムの新しいバージョンがある場合に影響を受けることがないように、ユーザーの認識からの影響は比較的小さかった、関係者に主導権を把握するためのアップグレードシステムを制御することができますアップグレードする場合は、利害関係者はまた、自分の条件に応じてすることができます。

 

アプリケーションシナリオのための第二に、インタフェース

    インターフェイスのデザインは、我々はまた、インターフェースがウェブやモバイルアプリの開発、またはサーバ側の開発のためのフロントエンドの開発である場合には検討してください。異なるシナリオ全体計画は、異なるインターフェイスである(例えば:私たちは、ウェブインターフェースまたはAPP先端用途を提供する場合、我々は、バックエンドへのインターフェースを提供する場合、我々は、のようなoauth2.0、インタフェースセキュリティ検証JWTを使用することができサービスを使用しているとき、私は)トークンのメカニズムを使用することができます。

 

第三に、プロセス要求統一と規範的パラメータ

    規範的パラメータ要求は、パラメータの仕方を受信するインタフェースの種類、であることを意味します。それはJSONまたはXML形式の方法を使用して受信されたか、フォームが受信された統一的な方法です。

    インターフェースの開発に正しいパラメータ、較正および他の操作を受けるように一箇所に統一されるべきです。パラメータの整合性を確保するために、我々は署名検証プロセスを追加することを検討することができます。

 

第四に、戻り値のデータ型、およびコード情報は、規範的なヒントを返さ

(例:返品の統一を、またはXMLの形で団結に戻り、の形でJSON)クライアントに返されるデータ型は統一されなければなりません。

 

火は今、彼らはrestfullスタイルのコードの規定を返すことが許されるべきで非常に人気のrestfullスタイルであれば異なるデザインモードインターフェースの戻りコードは、異なるものになります。あなたが統一されたカスタムリターンコードを使用している場合は、デザインコードで返す、あなたが例えば(リターン・コード・セグメントを処理するために、さまざまなビジネス処理モジュールを学習する必要があります:私たちは10000から10050までの基本的な管理を使用するシステムで、ユーザー管理を、あなたが望むならば、我々はモジュールの開発のため、後者は、他の事業拡大や調整の問題を有していてもよいので、脇に十分な戻りコードを設定する必要があり、異なるビジネス・モジュールの10051から10100、......)。

 

断片化プロセスの戻りコードの一つの利点は、便利にインターフェースの利害関係者は、迅速に見つけることができ呼び出しでエラーが属する部分であるが、ここで、インタフェースエラーに配置するインターフェースの開発を容易にします。

 

リターンコードに加えて、我々は、チップ上の点は明らかであるインタフェースのエラーメッセージとインタフェース呼出成功メッセージに戻ります。もちろん、いくつかのエラーメッセージがバグなどの要因であるか、または独自のサーバーのAPIを発行して、私たちは自分の問題公開されたインターフェースAPI呼び出しの当事者を促したものを変換してはならないことがあり、これは、このようなインタフェースなどのセキュリティ上の問題につながります。

 

第五に、制御インタフェースセキュアな認証と権限

    各オペレータインタフェースは、アクセスを要求することはできませんので、我々は、ユーザのログインシステムのように、安全な認証を提供するインタフェースする必要があり、我々のシステムの正当な登録ユーザーが存在しない、我々は、アクセスを要求することはできません。だから、どのように我々は、インターフェイス、それの安全性を確認できますか?実際には、我々は、例えば(異なるアプリケーションシナリオで同じ安全な認証インターフェースではありません。私たちのインターフェースは、APPのWebフロントエンドまたは最終用途に利用可能であるとき、安全な認証インターフェース私たちのインターフェースがある場合、我々はJWT、oauth2.0などを使用することができます使用するバックエンドサービスを提供し、その後、私は)トークンのメカニズムを使用することができます。

 

    制御権限が異なるユーザーグループするための手段であって、我々は、異なるアクセス許可を割り当てる必要があり(例:スーパー管理者は、操作の一部のみを許可するようにすべてのインターフェイス、共通のユーザー・インターフェースを操作することができます)、どこが違うのインターフェイスのために呼び出すことができるユーザー数に加えて、利害関係者の権限を制御するために(ここでは、利害関係者は、アプリケーションの呼び出しインタフェースを参照します)。

 

第六に、呼び出し周波数インタフェース制御

    一方、コール頻度インタフェース制御にもインターフェイスの安全性と保守性のために、当然のことながら、ここでかインターフェイス設計の異なるシナリオに応じて制御するために、インタフェースのいくつかは、訪問をインターフェースコール頻度を制限する必要があり、いくつかのインタフェースは、インタフェース呼び出しでありません(例えば、厳密に制御されるべきである。周知のマイクロチャネルパブリック数の開発は、異なるシナリオおよびユーザグループの周波数インタフェースの制約および制限を呼び出すことです周波数)は同じではありません。

 

七、レコードインターフェースをログ要求

    我々後のメンテナンスインタフェースが大幅にメンテナンスコストを削減するとき私たちは、そう、インタフェース要求のいくつかのロギングを行う必要があります。しかし、また、ログの関連統計処理のために。

 

八、文書インタフェースの可読性

    可読性インターフェイスのドキュメントは本当に人々があなたのインターフェースを使用していない場合は、完了するためのインタフェースを開発していない、非常に重要であり、その後、開発あなたのインターフェースが役に立たない、非常に多くのプログラマは注意を払い、インターフェイスのドキュメントを書きませんインタフェース文書の読みやすさ、大きな頭を見て、聖書のように書かれた文書。良いドキュメントはように無地でシンプルな、ピットの一部を回避する方法を、人々はどのようにコールすることを見てみましょう、とすべきです。

おすすめ

転載: www.cnblogs.com/mo3408/p/11007471.html