Skip to main content

 

拡張および連携

 

OutSystems

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

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

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

これを行うには、以下の手順を実行します。

  1. REST APIメソッドおよびそれらのパラメータのDescriptionプロパティが入力されていることを確認します。Descriptionでは、Markdown構文を使用してテキストの書式設定ができます。
  2. アプリケーションをパブリッシュします。

ドキュメントは、REST APIのベースURLで入手できるようになっています。これを開くには、REST APIを右クリックし、[Open Documentation]を選択します。

  • Was this article helpful?