建立 RESTful Web 服務
使用模組、範本及處理程式頁面建立 RESTful Web 服務。
若要建立 RESTful Web 服務,您必須:
-
定義資源模組
-
定義資源樣板
-
定義一或多個資源處理程式,例如 GET、PUT、POST 或 DELETE。您可以選擇性地定義需要傳送至資源處理程式的參數。
下列各節提供如何建立資源模組、資源樣板以及資源處理程式的資訊。
- 管理資源模組
您可以在「模組」頁面中定義、編輯及刪除資源模組。 - 管理資源樣板
您可以在「樣板」頁面中定義、編輯及刪除模組的資源樣板。 - 管理資源處理程式
您可以在「處理程式」頁面中建立、編輯及刪除樣板的資源處理程式。 - 範例:使用 POST 處理程式插入記錄
下列範例說明如何在 DEPT 表格中插入記錄。
另請參閱:
-
Oracle REST Data Services 快速入門指南中的 Creating a RESTful Service
父項主題: REST 頁面
管理資源模組
您可以在「模組」頁面中定義、編輯及刪除資源模組。
若要瀏覽至「模組」頁面,請在「REST 總覽」頁面中,按一下「物件」中的模組,或從標頭的功能表中選取模組。
卡片檢視中預設顯示的模組屬性如下圖所示。
可以發佈或取消發佈模組狀態。如果狀態為未發布,圖示會以紅色顯示。
按一下卡片檢視中的模組名稱,即可移至該模組的「範本」頁面。您也可以透過相關內容功能表瀏覽至「範本」頁面。
相關內容功能表中可用的動作如下:
-
瀏覽至模組的「樣板」頁面
- 建立資源模組
本節說明如何建立資源模組。 - 匯入資源模組
- 編輯資源模組
本節說明如何編輯資源模組。 - 刪除資源模組
本節說明如何刪除資源模組。 - 發佈 / 取消發佈資源模組
本節說明如何讓資源模組可供使用。 - 匯出資源模組
您可以匯出資源模組或 RESTful 服務的 API 或 Open API (Swagger) JSON 程式碼的 PL/SQL 原始碼。如果模組具有範本、處理程式、參數、角色等等,這些物件也會一併顯示和匯出。 - 在 OpenAPI 檢視中檢視模組
本節說明如何在 Open API 檢視中開啟模組。
另請參閱:
關於 REST 搜尋工具列父項主題:建立 RESTful Web 服務
匯出資源模組
您可以匯出資源模組或 RESTful 服務的 API 或 Open API (Swagger) JSON 程式碼的 PL/SQL 原始碼。如果模組具有範本、處理程式、參數、角色等等,這些物件也會一併顯示和匯出。
父項主題:管理資源模組
管理資源樣板
您可以在「樣板」頁面中定義、編輯及刪除模組的資源樣板。
若要瀏覽至此頁面,請在「模組」頁面中,按一下模組的
並選取範本,或在卡片檢視中按一下模組的名稱。
在頁面頂端,模組卡可使用內容功能表選項,例如編輯、刪除、發布及匯出。
在卡片檢視中預設顯示的範本屬性如下圖所示。
按一下卡片檢視中的範本名稱,即可移至「處理程式」頁面。您也可以透過相關內容功能表瀏覽至「處理程式」頁面。
相關內容功能表中可用的動作如下:
父項主題:建立 RESTful Web 服務
管理資源處理程式
您可以在「處理程式」頁面中建立、編輯及刪除樣板的資源處理程式。
若要瀏覽至此頁面,請在「範本」頁面中,按一下範本的
並選取處理程式,或在卡片檢視中按一下範本的名稱。
在頁面頂端,範本卡可使用內容功能表選項,例如「編輯」與「刪除」。
卡片檢視中預設顯示的處理程式屬性如下圖所示。
HTTP 方法可以是下列其中一種方法:GET、PUT、POST 以及 DELETE。
您可以使用相關內容功能表瀏覽至 HTTP 方法頁面。「HTTP 方法」頁面中會顯示三個頁籤:「來源」、「參數」以及「預先認證的要求」。
附註:
如果範本已建立四個處理常式 (GET、POST、PUT、DELETE),則無法使用此選項。相關內容功能表中可用的動作如下:
-
編輯:請參閱編輯資源處理程式
-
刪除:請參閱刪除資源處理程式
-
詳細資訊:請參閱檢視資源處理程式詳細資訊及管理參數
-
預先認證的要求:請參閱預先認證的要求
- 建立資源處理程式
本節說明如何建立資源處理程式。 - 編輯資源處理程式
本節說明如何編輯資源處理程式。 - 刪除資源處理程式
本節說明如何刪除資源處理程式。 - 檢視資源處理程式詳細資訊及管理參數
您可以在 HTTP 方法頁面中檢視資源處理程式詳細資訊及管理參數。 - 使用預先認證的要求來存取 ORDS RESTful 服務
若要存取受保護的 RESTful 服務,您可以建立和撤銷預先認證的要求。
父項主題:建立 RESTful Web 服務
檢視資源處理程式詳細資訊及管理參數
您可以在 HTTP 方法頁面中檢視資源處理程式詳細資訊及管理參數。
若要導覽至此頁面,請針對特定處理程式,按一下
,然後選取詳細資訊,或在卡片檢視中按一下處理程式的名稱。
在頁面頂端,處理常式卡可使用相關內容功能表選項,例如「編輯」與「刪除」。
「處理程式 HTTP 方法」頁面有兩個主要區段:
-
用於執行在資源處理程式中定義之 SQL 或 PL/SQL 原始程式碼的程式碼編輯器。您可以執行程式碼、儲存、還原、重做、下載和清除輸出。如需有關編輯器的詳細資訊,請參閱在程式碼編輯器中執行 SQL 敘述句。
REST 服務處理程式中使用的隱含參數會顯示在編輯器右側的捲動清單中。請參閱隱含參數
-
此區段用於管理執行 HTTP 方法所需的參數。
依預設,參數會顯示在方格檢視中。顯示在卡片檢視中參數的屬性如下圖所示。
相關內容功能表中可用的動作如下:
- 建立參數
本節說明如何建立資源處理程式的參數。 - 編輯參數
本節說明如何編輯參數。 - 刪除參數
本節說明如何刪除參數。 - 隱含參數
本節描述「資源處理程式詳細資訊」頁面中的隱含參數。這些參數會自動新增至資源處理程式。
另請參閱:
關於 REST 搜尋工具列父項主題:管理資源處理程式
隱含參數
本節描述「資源處理程式詳細資訊」頁面中的隱含參數。這些參數會自動新增至資源處理程式。
表格 4-1 隱含參數
| 名稱 | Type | 存取模式 | HTTP 標頭 | 描述 |
|---|---|---|---|---|
|
|
BLOB |
IN |
無 |
將要求的主體指定為暫時 BLOB。 |
|
|
CLOB |
IN |
無 |
將要求的主體指定為暫時 CLOB。 |
|
|
VARCHAR |
IN |
|
指定要求主體的 MIME 類型,如 Content-Type 要求標頭所指示。 |
|
|
VARCHAR |
IN |
無 |
指定要求的已認證使用者。若未認證使用者,則會將值設為空值。 |
|
|
VARCHAR |
OUT |
|
指定 Oracle REST Data Services 必須轉寄 GET 要求以產生此要求回應的位置。 |
|
|
NUMBER |
IN |
無 |
指定要在頁面上顯示之第一個資料列的零基偏移量。 |
|
|
NUMBER |
IN |
無 |
指定要在頁面上擷取的資料列數目上限。 |
|
|
NUMBER |
IN |
無 |
指定分頁要求中的零基頁偏移量。 注意: |
|
|
NUMBER |
IN |
無 |
指定要在頁面上擷取的資料列數目上限。
|
|
|
NUMBER |
IN |
無 |
指定要在分頁要求中顯示之第一個資料列的一個式索引。 |
|
|
NUMBER |
IN |
無 |
指定要在分頁要求中顯示之最後一個資料列的一個式索引。 |
|
|
NUMBER |
OUT |
|
指定要求的 HTTP 狀態代碼。 |
如需有關隱含參數的詳細資訊,請參閱 Oracle REST Data Services Developer's Guide。
父項主題:檢視資源處理程式詳細資訊及管理參數
使用預先認證的要求來存取 ORDS RESTful 服務
若要存取受保護的 RESTful 服務,您可以建立及撤銷預先認證的要求。
預先認證的要求可讓您無需使用者證明資料,即可存取受保護的 ORDS RESTful 服務。當您建立預先認證要求時,會產生唯一的 URL。您可以將此 URL 提供給外部使用者,以使用標準 HTTP 工具與特定 RESTful 實體互動。
如需有關預先認證要求的詳細資訊,請參閱 Oracle REST Data Services Developer's Guide 中的 Oracle REST Data Services Pre-Authenticated Requests 。
若要瀏覽至「預先認證的要求」頁面,您可以執行下列其中一項作業:
-
從「總覽」頁面中,按一下預先認證的要求磚塊。
-
從功能表列展開安全,然後選取預先認證的要求。
主題:
建立預先認證的要求
建立現有處理程式的預先認證要求:
-
從現有處理程式的相關內容功能表中,選取建立新的預先認證要求。
就會顯示「建立預先認證的要求」面板。
-
在權杖到期欄位中,輸入權杖到期持續時間 (秒)。
選取顯示程式碼,即可檢視建立預先認證要求的基礎原始程式碼。
按一下建立。
便會顯示存取資源的記號、別名和相對連結。您必須持續追蹤記號和別名,因為您之後無法取得其值。如果忘記值,您可以撤銷記號並再次建立新的記號。



