Informazioni sulle API REST di Oracle API Platform Cloud Service

Oracle API Platform Cloud Service fornisce servizi Web REST che è possibile utilizzare per automatizzare determinati task.

Le API REST incluse in Oracle API Platform Cloud Service sono:

  • Servizio di amministrazione: fornisce operazioni per gestire gli artifact del gateway, creare e ottenere informazioni sui criteri, ottenere e aggiornare le preferenze utente e ottenere informazioni sui ruoli e i privilegi per gli utenti, tra le altre operazioni amministrative.
  • Analisi dei dati: fornisce operazioni per ottenere statistiche e informazioni sulle prestazioni quali applicazioni attive, errori, numero totale di richieste, gateway attivi, richieste e risposte come dati delle serie temporali e così via.
  • Servizio consumer: fornisce operazioni che supportano la creazione e l'eliminazione delle applicazioni oppure aggiornano le informazioni sull'applicazione, aggiungono o rimuovono concessioni alle applicazioni, gestiscono le impostazioni di configurazione del portale per sviluppatori, impostano o eliminano le preferenze utente e così via.
  • Controller gateway: fornisce operazioni correlate alla configurazione dei nodi e ai profili di sicurezza.
  • Servizio di gestione: fornisce operazioni per creare e distribuire API, autorizzazioni API, creare e gestire applicazioni, distribuzioni e abilitazioni API tra altre operazioni.

The Management Service is a REST API that you can use to create and deploy APIs in Oracle API Platform Cloud Service.

Utilizzare l'API di gestione di Oracle API Platform Cloud Service per creare una nuova API

Utilizza l'API di gestione di Oracle API Platform Cloud Service per creare le interfacce API mediante REST.

Per creare un'interfaccia API utilizzando l'API REST di gestione, è possibile utilizzare cURL o il client REST di preferenza per eseguire il test in base al quale si dispone del ruolo API Manager prima di eseguire i comandi REST negli script.

  1. In un editor creare un modello JSON di base per la richiesta cURL con le informazioni riportate di seguito.
    {
        "name": "YOUR_API_NAME",
        "version": "YOUR_API_VERSION",
        "implementation":
        {
            "policies": [
            {
                "id": "1",
                "type": "o:ApiRequest",
                "version": "1.0",
                "draft": true,
                "config":
                {}
            },
            {
                "id": "2",
                "type": "o:ServiceRequest",
                "version": "1.0",
                "draft": true,
                "config":
                {}
            },
            {
                "id": "3",
                "type": "o:ServiceResponse",
                "version": "1.0",
                "config":
                {}
            },
            {
                "id": "4",
                "type": "o:ApiResponse",
                "version": "1.0",
                "config":
                {}
            }],
            "executions":
            {
                "request": ["1", "2"],
                "response": ["3", "4"]
            }
        }
    }

    Nel modello JSON, name è il nome dell'API e version è la versione dell'API. Questo modello dispone delle informazioni essenziali minime necessarie per creare un'API in Oracle API Platform Cloud Service, ad esempio un nome API, una versione, i criteri Richiesta API e Richiesta di servizio in modalità bozza e i criteri Risposta servizio e Risposta API.

  2. By using cURL or your REST client, make a POST request to the https://YOUR-API-PCS-INSTANCE-URL/apiplatform/management/v1/apis endpoint, where YOUR-API-PCS-INSTANCE-URL is the URL of your Oracle API Platform Cloud Service instance.
  3. Verificare le intestazioni della risposta dalla richiesta e dal corpo della risposta.
    HTTP/1.1 200 OK 
    Server: Oracle-Traffic-Director/12.2.1.0.0
    Date: Tue, 19 Jul 2016 13:27:08 GMT
    Content-Length: 30
    Content-Type: application/json
    X-oracle-dms-ecid: dd439614-7d4f-47ad-a1ea-a25a74ec9403-0000032d
    X-oracle-dms-rid: 0:1
    Via: 1.1 otd_opc
    Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0

    Anche il corpo della risposta dal server è in formato JSON.

    {
      "id": "101",
      "iterationId": "1"
    }