Skip to main content

 

拡張と連携

 

 

OutSystems

公開しているREST APIをドキュメント化する

REST APIにドキュメントを追加することは、開発者によるアプリケーションとシステムの連携作業を容易にする上で不可欠です。

OutSystemsは、モジュールのパブリッシュ時にドキュメントを自動生成することにより、REST APIのドキュメント化を容易にします。ドキュメントは、REST API、REST APIのメソッド、およびそれらのパラメータのプロパティに基づいています。

以下の手順を実行します。

  1. Service Studioで、REST APIメソッドとそれらのパラメータの「Description」プロパティが入力されていることを確認します。Markdownを使用して説明テキストの書式設定ができます。

  2. モジュールをパブリッシュします。

ドキュメントは、REST APIのベースURLで入手できます。開くには、以下の手順を実行します。

  1. Service Studioで、REST APIのツリー要素を右クリックします。

  2. Open Documentation]を選択します。

  • Was this article helpful?