Skip to main content

 

拡張および連携

 

OutSystems

REST APIを公開する

メソッドを公開して別のシステムが情報を取得または操作できるようにするには、REST APIを利用します。

REST APIサービスを作成する

  1. [Logic]タブで、Integrationsフォルダを開きます。
  2. [REST]を右クリックし、[Expose REST API...]を選択します。
  3. REST APIの名前を設定します。例: PhoneBook。

REST APIメソッドを作成する

  1. REST APIを右クリックし、[Add REST API Method]を選択します。
  2. REST APIメソッドの名前を設定します。例: GetContacts、CreateContact、UpdateContact。
  3. メソッドが実行するアクションに対応するHTTP動詞にHTTP Methodプロパティが設定されていることを確認します。

    • GET - 読み取り
    • POST - 作成
    • PUT - 更新
    • DELETE - 削除
  4. 公開するデータを取得または操作するアクションとして、メソッドを設計します。例: GetContactsはすべてのContactsのリストを返し、CreateContactまたはUpdateContactはContactsレコードを受け取り、作成または更新されたContactsのIDを返します。

アプリケーションをデプロイすると、REST APIエンドポイントにアクセスできるようになります。 例:

デフォルトのエンドポイント 説明
GET https://<server>/MyAPI/rest/PhoneBook/GetContacts Gets all contacts.
GET https://<server>/MyAPI/rest/PhoneBook /GetContact Gets a contact.
POST https://<server>/MyAPI/rest/PhoneBook/CreateContact Creates a contact.
PUT https://<server>/MyAPI/rest/PhoneBook/UpdateContact Updates a contact.
DELETE https://<server>/MyAPI/rest/PhoneBook/DeleteContact Deletes a contact.
GET https://<server>/MyAPI/rest/PhoneBook/GetContactAddresses Gets all addresses of a contact.

デフォルトのエンドポイントは、HTTPメソッド(GET、POST、PUT、DELETE)と、REST APIメソッドの名前に基づいていますが、必要に応じてエンドポイントをカスタマイズできます。

CurlやPostmanなどの利用可能なツールを使用してREST APIメソッドをテストしたり、そのエフェクト用にOutSystemsアプリケーションを構築することができます。

入力パラメータがRecord(POSTやPUTなど)の操作メソッドの場合は、Content-Typeヘッダーの値をapplication/jsonにしてリクエストに追加する必要があります。

  • Was this article helpful?