Gestisci risorse API

Questa pagina si applica ad Apigee e Apigee hybrid.

Registra un'API

Quando registri un'API con l'hub delle API, crei e archivi un'entità che rappresenta l'API. La definiamo una risorsa API. Le risorse API archiviate nell'hub API sono disponibili per la ricerca e forniscono informazioni operative e descrittive dettagliate sull'API. Al momento della registrazione di un'API o in seguito, puoi aggiungere e modificare gli attributi delle risorse dell'API per creare una descrizione esaustiva dell'API.

Console

Per registrare un'API:

  1. Nella console Google Cloud, vai alla pagina API nell'hub API Apigee.

    Vai all'hub API
  2. Fai clic su Registra API.

  3. In Dettagli generali, puoi specificare facoltativamente un ID univoco per l'API. Se non fornisci un ID, il sistema ne genererà uno automaticamente. Se vuoi inserire un ID, fai clic su Specifica ID univoco.

    L'ID deve contenere da 4 a 500 caratteri e i caratteri validi sono /[A-Z][a-z][0-9]-/. L'ID è l'ultimo componente del nome completo e univoco della risorsa API, che ha il formato projects/PROJECT/locations/LOCATION/apis/API_ID

  4. (Obbligatorio) Fornisci un nome visualizzato per la risorsa API.
  5. Facoltativamente, aggiungi altri attributi che descrivono l'API. Puoi tornare all'API in qualsiasi momento per aggiungere o modificare gli attributi dell'API. Vedi Modificare una risorsa API.
    • (Facoltativo) Informazioni sul proprietario: il nome e l'indirizzo email del proprietario dell'API.
    • Ulteriori dettagli: (facoltativo) specifica gli attributi per semplificare la definizione dell'API e facilitarne la ricerca. Puoi definire i valori predefiniti per alcuni di questi attributi in Impostazioni. Per maggiori dettagli, vedi Gestire gli attributi.
    • Attributi definiti dall'utente: (facoltativi) sono gli attributi che definisci nelle Impostazioni. Per maggiori dettagli, vedi Gestire gli attributi.
  6. Fai clic su Registrati.

REST

Per registrare un'API, utilizza l'API REST Create API.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{
    "display_name": "DISPLAY_NAME",            # Required attribute
    "description": "DESCRIPTION"               # description is an optional attribute
    }
    'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis?api_id=API_ID

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • API_ID: (facoltativo) inserisci un ID univoco per l'API. Se non fornisci questo parametro di query, il sistema genererà un ID univoco per te. L'ID deve contenere da 4 a 500 caratteri e i caratteri validi sono /[A-Z][a-z][0-9]-/. L'ID è l'ultimo componente del nome completo e univoco della risorsa API, che ha il formato projects/PROJECT/locations/LOCATION/apis/API_ID
  • DISPLAY_NAME: (obbligatorio) il nome visualizzato della risorsa API. Puoi usare il nome che preferisci.
  • DESCRIPTION: (facoltativo) puoi aggiungere una serie di attributi facoltativi per descrivere la risorsa API, tra cui una descrizione, un proprietario, un link alla documentazione dell'API e altro ancora. Questi attributi facoltativi sono elencati e descritti nella definizione della risorsa API.

Elenco risorse API

Questa sezione spiega come elencare le risorse API nell'hub API. Aggiungendo un filtro, puoi limitare le API restituite nella risposta.

Console

Per elencare le risorse API:

  1. Nella console Google Cloud, vai alla pagina API nell'hub API Apigee.

    Vai all'hub API

    Un elenco di tutte le API aggiunte all'hub API è elencato nella home page delle API.

  2. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.

REST

Per elencare tutte le risorse API nel progetto hub API, utilizza l'API List APIs:

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis"
  -X GET -H "Authorization: Bearer: $(gcloud auth print-access-token)" -H "Content-Type: application/json"

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.

Esempio di output:

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-2",
      "displayName": "TestApi2",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/a035eb3b-658e-467a-89d3-9cca2bbacd32-1",
      "displayName": "TestApi1",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/foo9013cfev",
      "displayName": "sample",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/foo90121",
      "displayName": "sample",
      "documentation": {}
    },
    ...
    ],
    "nextPageToken": "f4f4d78b-a974-46db-a214-dc139f8e9c8a"
  }

Esempio REST con filtro

Puoi filtrare i risultati dell'elenco utilizzando l'API. In questo esempio, le API vengono filtrate in base a un attributo definito dal sistema: 

curl -X GET -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis' \
  -d filter="owner.email=\"testowner3@gmail.com\"" -d page_size=10

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.

Output di esempio, filtrato per proprietario:

{
  "apis": [
    {
      "name": "projects/myproject/locations/us-central1/apis/theme-park-management-api",
      "displayName": "Theme Park Management API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/restaurant-api",
      "displayName": "Restaurant API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/casino-management-api",
      "displayName": "Casino Management API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/hotel-boooking-api",
      "displayName": "Hotel Booking API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api3",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api2",
      "displayName": "Test Pets API",
      "documentation": {}
    },
    {
      "name": "projects/myproject/locations/us-central1/apis/test-march-26-api1",
      "displayName": "Test Pets API",
      "documentation": {}
    }
  ]
}

Ottieni dettagli risorsa API

Questa sezione spiega come ottenere i dettagli su una risorsa API.

Console

Per visualizzare i dettagli di una risorsa API:

  1. Nella console Google Cloud, vai alla pagina API nell'hub API Apigee.

    Vai all'hub API
  2. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API.
  3. Fai clic su un'API per visualizzare la relativa pagina dei dettagli.

REST

Per visualizzare i dettagli di una risorsa API, utilizza l'API Get API resource details (Ottieni dettagli risorse API):

curl "https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID"
  -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • API_ID: l'ID univoco della risorsa API.

Esempio di output:

{
  "name": "projects/myproject/locations/us-central1/apis/myapi",
  "displayName": "My Test API",
  "description": "This is a test API.",
  "documentation": {},
  "owner": {
    "displayName": "Test API,
    "email": "testowner@gmail.com"
  },
  "versions": [
    "projects/myproject/locations/us-central1/apis/myapi/versions/myapi-version1"
  ],
  "createTime": "2024-03-26T10:13:15.668867002Z",
  "updateTime": "2024-03-26T10:13:16.700716401Z"
}

Elimina una risorsa API

Questa sezione spiega come eliminare una risorsa API.

Console

Per eliminare una risorsa API:

  1. Nella console Google Cloud, vai alla pagina API nell'hub API Apigee.

    Vai all'hub API
  2. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API da eliminare.
  3. Dal menu Azioni (sul lato destro della riga contenente l'API), fai clic su Elimina.

REST

Per eliminare un'API dall'hub API, utilizza l'API Delete API:

curl -X DELETE -H "Authorization: Bearer $(gcloud auth print-access-token)" \
  'https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID'

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • API_ID: l'ID univoco della risorsa API da eliminare.

Modifica una risorsa API

Questa sezione spiega come modificare una risorsa API. Non tutti gli attributi delle risorse API sono modificabili. Per l'elenco degli attributi modificabili, vedi il documento di riferimento dell'API Patch.

Console

Per modificare un'API:

  1. Nella console Google Cloud, vai alla pagina API nell'hub API Apigee.

    Vai all'hub API
  2. Utilizza Filtra per specificare le parole chiave per filtrare l'elenco delle API. Se necessario, utilizza la ricerca per individuare un'API da modificare.
  3. Fai clic su un'API per visualizzare la relativa pagina dei dettagli.
  4. Fai clic su Modifica API.
  5. Nella pagina Edit API (Modifica API), apporta le modifiche. Fai clic su Continua per passare al set di attributi modificabili successivo.
    • Dettagli generali: puoi modificare il nome visualizzato dell'API.
    • Informazioni proprietario: il nome e l'indirizzo email del proprietario dell'API.
    • Ulteriori dettagli: si tratta degli attributi definiti dal sistema. Puoi specificare valori predefiniti personalizzati per questi attributi in Gestisci attributi.
    • Attributi definiti dall'utente: sono gli attributi personalizzati definiti dall'utente. Puoi specificare attributi personalizzati in Gestisci attributi.
  6. Fai clic su Salva.

REST

Per modificare una risorsa API, utilizza l'API Patch API Resource.

curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" -d '{
          "display_name": "Updated Test Docs API",        # Example request body with changes
          "description": "This is the updated test API.",
          "owner": {
            "display_name": "Updated Docs Owner",
            "email": "updateddocsowner@gmail.com"
            }
          }
          ' https://apihub.googleapis.com/v1/projects/HUB_PROJECT/locations/HUB_LOCATION/apis/API_ID

Sostituisci quanto segue:

  • HUB_PROJECT: il nome del progetto host dell'hub API. Il progetto host è stato selezionato al momento del provisioning dell'hub API.
  • HUB_LOCATION: la posizione del progetto host. La località è stata scelta al momento del provisioning dell'hub API.
  • API_ID: l'ID univoco dell'API da aggiornare.
  • Corpo della richiesta: utilizza il corpo della richiesta per specificare gli attributi da modificare. Consulta la descrizione del corpo della richiesta API.