Documenting the BAPI

使用する

BAPIドキュメントの品質は、次の原則によって異なります。

SAPシステムに精通していないが、ビジネスの背景に精通している外部開発者がBAPIを使用できるように、ドキュメントは十分に詳細である必要があります。

特徴

BAPIのドキュメントは、次の4つの領域をカバーしています。

1. SAPビジネスオブジェクトタイプのドキュメント。

2. メソッドのドキュメントは、次の質問に答える必要があります。

   1. BAPIのビジネス機能とは何ですか？また、それは何のために使用されますか？

   2. BAPI関数は実際に何をしますか？

   3. 重要な制限はありますか？つまり、このBAPIが実行できない機能はありますか？

   4. このBAPIで特に注意しなければならないこと（たとえば、権限チェック）はありますか？他にどのような前提条件がBAPIに適用されますか？

   5. カスタマイジングの依存関係はありますか？

   6. このBAPIと他のBAPIの間、および個々のメソッドパラメータの間にはどのような依存関係がありますか？

   7. バッファリング付きのBAPIですか？

      そうである場合、BAPIはそのように明示的に識別される必要があります。

   8. BAPIにはCOMMITWORKコマンドが含まれていますか？

      含まれている場合は、文書化する必要があります。

3. BAPIパラメータのドキュメントは、次の質問に答えます。

   1. 使用されるパラメータは何ですか？

   2. パラメータのどのフィールドに入力する必要がありますか。つまり、必須フィールドは何ですか。

   3. フィールド間の依存関係は何ですか？

      構造内にパラメーターの依存関係とフィールドの依存関係はありますか？

   4. 固定値はありますか？それらは何をしますか？

   5. パラメータのデフォルト値は何ですか？

      カスタマイジングによってデフォルト値が割り当てられ、したがって書き込み保護されているすべてのフィールドを文書化する必要があります。

   6. 戻りパラメーターのドキュメントはガイドラインに準拠しており、関連するすべてのエラーメッセージが含まれていますか？

   7. 終了がある場合、データベースのロールバックはBAPI内の例外として実行されますか？

      そうである場合は、returnパラメーターのドキュメントでこのプロセスを説明する必要があります。

   8. 拡張パラメータ（ ExtensionIn、 ExtensionOut ）のドキュメントに、使用可能なすべてのBAPIテーブル拡張がリストされていますか？

4. BAPIパラメータのフィールドの基礎となるデータ要素のドキュメント。

詳しくは

デモビジネスオブジェクトタイプFlight、 FlightBooking、 FlightCustomer、および対応するBAPIメソッドに関するドキュメントも参照してください。