Pubblica le tue API

UI

Per visualizzare il catalogo API:

1. Seleziona Pubblica > Portali e seleziona il tuo portale.
2. Fai clic su Catalogo API nella home page del portale. In alternativa, puoi selezionare Catalogo API nel menu a discesa del portale nella barra di navigazione in alto.

La scheda API nel catalogo delle API mostra un elenco delle API che sono state aggiunte al tuo portale.

Come evidenziato nella figura precedente, la scheda API ti consente di:

• Visualizza i dettagli delle API disponibili sul tuo portale
• Aggiungere un'API al tuo portale
• Modifica un'API nel tuo portale eseguendo una o più delle seguenti attività:
  • Gestisci lo snapshot di un documento associato a un prodotto API per aggiornare la documentazione di riferimento dell'API
  • Pubblicare o annullare la pubblicazione di un'API sul tuo portale
  • Gestisci la visibilità di un'API nel tuo portale:
  • Gestire l'URL di callback per un'API
  • Gestire l'immagine di una scheda API
  • Taggare un'API utilizzando le categorie
  • Modificare il titolo e la descrizione dell'API
• Rimuovere un'API dal portale
• Gestire le categorie utilizzate per trovare le API correlate
• Identificare rapidamente le specifiche non aggiornate o eliminate dall'apposito store
• Identifica rapidamente le API orfane il cui prodotto API associato è stato rimosso da Apigee Edge e crea nuovamente il prodotto API o elimina l'API dal tuo portale

curl

Per elencare le API:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
• ACCESS_TOKEN con il token di autenticazione utilizzato per accedere all'API Apigee Edge. Per ulteriori informazioni su autenticazione e token, vedi Autenticare l'accesso all'API Edge.

Consulta le Note sull'impaginazione per istruzioni sull'utilizzo dell'impaginazione nel payload della risposta.

Payload della risposta:

{
  "status": "success",
  "message": "one page of apidocs returned",
  "data": [
    {
      "id": 622759,
      "siteId": "my-org-myportal",
      "title": "Test",
      "description": "",
      "published": false,
      "visibility": false,
      "apiId": "apiproducttest18",
      "apiProductName": "apiproduct_test18",
      "edgeAPIProductName": "apiproduct_test18",
      "specId": null,
      "specContent": null,
      "specTitle": null,
      "snapshotExists": false,
      "snapshotModified": null,
      "modified": 1724144471000,
      "anonAllowed": false,
      "imageUrl": null,
      "snapshotState": null,
      "requireCallbackUrl": false,
      "categoryIds": [],
      "specFormat": null,
      "specModified": null,
      "snapshotOutdated": false,
      "snapshotSourceMissing": false,
      "graphqlSchema": null,
      "graphqlEndpointUrl": null,
      "graphqlSchemaDisplayName": null,
      "grpcFileName": null,
      "grpcZipContent": null
    }
  ],
  "code": null,
  "request_id": "1452867334",
  "error_code": null,
  "next_page_token": ""
}

Dove:

• modified: data e ora dell'ultima modifica dell'elemento del catalogo in millisecondi dall'epoch. Ad esempio, 1698165480000.
• id: l'ID dell'articolo del catalogo. Ad esempio, 399668.

Note sulla paginazione:

• Dimensioni pagina: utilizza pageSize per specificare il numero di elementi dell'elenco da restituire in una pagina. Il valore predefinito è 25 e il massimo è 100. Se sono presenti altre pagine, nextPageToken viene compilato con un token:

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE" \
     -H "Authorization: Bearer ACCESS_TOKEN"
  

  Sostituisci:

  • PAGE_SIZE con il numero di elementi dell'elenco da restituire in una pagina. Ad esempio, 10.

  Payload della risposta:

  {
    "status": "success",
    "message": "one page of apidocs returned",
    "data": [
      {
        "id": 638007,
        "siteId": "tsnow-mint-liztest",
        "title": "Testing",
        "description": "",
        "published": false,
        "visibility": false,
        "apiId": "testcatalog",
        "apiProductName": "testcatalog",
        "edgeAPIProductName": "testcatalog",
        "specId": "Petstore",
        "specContent": null,
        "specTitle": null,
        "snapshotExists": true,
        "snapshotModified": 1726508367000,
        "modified": 1728582504000,
        "anonAllowed": false,
        "imageUrl": null,
        "snapshotState": "OK_SUBMITTED",
        "requireCallbackUrl": false,
        "categoryIds": [],
        "specFormat": "YAML",
        "specModified": null,
        "snapshotOutdated": false,
        "snapshotSourceMissing": false,
        "graphqlSchema": null,
        "graphqlEndpointUrl": null,
        "graphqlSchemaDisplayName": null,
        "grpcFileName": null,
        "grpcZipContent": null
      }
    ],
    "code": null,
    "request_id": "1068810934",
    "error_code": null,
    "next_page_token": ""
  }
  

• Token pagina: utilizza pageToken per recuperare le pagine successive quando sono presenti più pagine:

  curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs?pageSize=PAGE_SIZE&pageToken=PAGE_TOKEN" \
        -H "Authorization: Bearer ACCESS_TOKEN"
  

  Sostituisci:

  • PAGE_SIZE con il numero di elementi dell'elenco da restituire in una pagina. Ad esempio, 10.
  • PAGE_TOKEN con il valore nextPageToken. Ad esempio, 7zcqrin9l6xhi4nbrb9.

UI

Per aggiungere un'API al tuo portale:

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.

3. Fai clic su + Aggiungi.

   Viene visualizzata la finestra di dialogo Aggiungi un prodotto API al catalogo.

4. Seleziona il prodotto API che vuoi aggiungere al tuo portale.

5. Fai clic su Avanti. Viene visualizzata la pagina Dettagli API.

6. Configura i contenuti della documentazione di riferimento dell'API e la relativa visibilità sul portale:

   Campo	Descrizione
   Pubblicato	Seleziona Pubblicata per pubblicare l'API nel tuo portale. Deseleziona la casella di controllo se non vuoi ancora pubblicare l'API. Puoi modificare l'impostazione in un secondo momento, come descritto in Pubblicare o annullare la pubblicazione di un'API sul tuo portale.
   Mostra titolo	Aggiorna il titolo dell'API visualizzato nel catalogo. Per impostazione predefinita, viene utilizzato il nome del prodotto dell'API. Puoi modificare il titolo visualizzato in un secondo momento, come descritto in Modificare il titolo visualizzato e la descrizione.
   Mostra descrizione	Aggiorna la descrizione dell'API visualizzata nel catalogo. Per impostazione predefinita, viene utilizzata la descrizione del prodotto dell'API. Puoi modificare la descrizione visualizzata in un secondo momento, come descritto in Modificare il titolo e la descrizione visualizzati.
   Richiedi agli sviluppatori di specificare un URL di callback	Attiva questa opzione se vuoi richiedere agli sviluppatori di app di specificare un URL di callback. Puoi aggiungere o aggiornare l'URL di callback in un secondo momento, come descritto in Gestire l'URL di callback per un'API.
   Documentazione relativa all'API	Per utilizzare un documento OpenAPI: Seleziona Documento OpenAPI. Fai clic su Seleziona documento. Esegui uno dei seguenti passaggi: Fai clic sulla scheda Le mie specifiche e seleziona una specifica dallo Store delle specifiche. Fai clic sulla scheda Carica file e carica un file. Fai clic sulla scheda Importa da un URL e importa una specifica da un URL. Fai clic su Seleziona. Per utilizzare uno schema GraphQL: Seleziona Schema GraphQL. Fai clic su Seleziona documento. Vai allo schema GraphQL e selezionalo. Fai clic su Seleziona. In alternativa, puoi selezionare Nessuna documentazione e aggiungerne una in un secondo momento dopo aver aggiunto l'API, come descritto in Gestire lo snapshot del documento.
   Visibilità API	Se non hai eseguito la registrazione alla versione beta della funzionalità di gestione dei segmenti di pubblico, scegli una delle seguenti opzioni: Utenti anonimi per consentire a tutti gli utenti di visualizzare l'API. Utenti registrati per consentire solo agli utenti registrati di visualizzare l'API. Se hai partecipato alla versione beta della funzionalità di gestione dei segmenti di pubblico, scegli una delle seguenti opzioni: Pubblica (visibile a tutti) per consentire a tutti gli utenti di visualizzare l'API. Utenti autenticati per consentire solo agli utenti registrati di visualizzare l'API. Segmenti di pubblico selezionati per selezionare i segmenti di pubblico specifici che vuoi che possano visualizzare l'API. Puoi gestire la visibilità del pubblico in un secondo momento, come descritto in Gestire la visibilità di un'API nel portale.
   Visualizza immagine	Per visualizzare un'immagine nella scheda dell'API nella pagina API, fai clic su Seleziona immagine. Nella finestra di dialogo Seleziona immagine, seleziona un'immagine esistente, carica una nuova immagine o fornisci l'URL di un'immagine esterna e fai clic su Seleziona. Visualizza l'anteprima della miniatura dell'API e fai clic su Seleziona. Puoi aggiungere un'immagine in un secondo momento, come descritto in Gestire l'immagine di una scheda API. Se specifichi un'immagine con un URL esterno, l'immagine non verrà caricata nelle tue risorse. Inoltre, il caricamento dell'immagine nel portale integrato sarà soggetto alla sua disponibilità, che potrebbe essere bloccata o limitata dalle norme sulla sicurezza dei contenuti.
   Categorie	Aggiungi le categorie a cui verrà applicato il tag dell'API per consentire agli sviluppatori di app di trovare le API correlate nella pagina API. Per identificare una categoria: Seleziona una categoria dall'elenco a discesa. Aggiungi una nuova categoria digitandone il nome e premendo Invio. La nuova categoria verrà aggiunta alla pagina Categorie e sarà disponibile quando aggiungi o modifichi altre API.

7. Fai clic su Salva.

curl

Per aggiungere un'API al tuo portale :

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": "IMAGE_URL",
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
         "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE,
        "apiProductName": "API_PRODUCT"
    }'

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
• ACCESS_TOKEN con il token di autenticazione utilizzato per accedere all'API Apigee Edge. Per ulteriori informazioni su autenticazione e token, vedi Autenticare l'accesso all'API Edge.
• TITLE con il nome visualizzato. Ad esempio, Hello World 2.
• DESCRIPTION con la descrizione del display. Ad esempio, Simple hello world example.
• ANON_TRUE_OR_FALSE con true o false (impostazione predefinita), dove true indica che questa API ha visibilità pubblica e può essere visualizzata in forma anonima; in caso contrario, solo gli utenti registrati possono visualizzarla.
• IMAGE_URL con l'URL di un'immagine esterna utilizzata per l'elemento del catalogo o un percorso file per i file immagine archiviati nel portale, ad esempio /files/book-tree.jpg. Quando specifichi l'URL di un'immagine esterna, l'immagine non verrà caricata nelle tue risorse. Inoltre, il caricamento dell'immagine nel portale integrato sarà soggetto alla sua disponibilità, che potrebbe essere bloccata o limitata dalle norme sulla sicurezza dei contenuti.
• CALLBACK_TRUE_OR_FALSE con true o false (valore predefinito), dove true richiede a un utente del portale di inserire un URL durante la gestione dell'app.
• CATEGORY_ID con l'ID della categoria. Ad esempio, bf6505eb-2a0f-47af-a00a-ded40ac72960. Separa più ID categoria con una virgola. Ottieni l'ID categoria con il comando list API categories.
• PUBLISHED_TRUE_OR_FALSE con true o false (valore predefinito), dove true indica che l'API è disponibile pubblicamente. Una volta pubblicata, puoi consentire l'accesso a tutti gli utenti, agli utenti autenticati o a utenti specifici.
• API_PRODUCT con il nome del prodotto dell'API. Ad esempio, Hello World 2.

Payload della risposta:

{
  "status": "success",
  "message": "API created",
  "data": {
    "id": 662423,
    "siteId": "my-org-myportal",
    "title": "My Test Catalog 4",
    "description": "",
    "published": false,
    "visibility": false,
    "apiId": "uxb9wjua",
    "apiProductName": "uXB9wJUa",
    "edgeAPIProductName": "uXB9wJUa",
    "specId": null,
    "specContent": null,
    "specTitle": null,
    "snapshotExists": false,
    "snapshotModified": null,
    "modified": 1729635493000,
    "anonAllowed": false,
    "imageUrl": null,
    "snapshotState": null,
    "requireCallbackUrl": false,
    "categoryIds": [],
    "specFormat": null,
    "specModified": null,
    "snapshotOutdated": null,
    "snapshotSourceMissing": false,
    "graphqlSchema": null,
    "graphqlEndpointUrl": null,
    "graphqlSchemaDisplayName": null,
    "grpcFileName": null,
    "grpcZipContent": null
  },
  "code": null,
  "request_id": "893346193",
  "error_code": null
}

Dove:

• modified: data e ora dell'ultima modifica dell'elemento del catalogo in millisecondi dall'epoch. Ad esempio, 1698165480000.
• id: l'ID dell'articolo del catalogo. Ad esempio, 399668.

UI

Per modificare un'API:

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Fai clic su Modifica.
5. In Dettagli API, apporta le modifiche necessarie. Consulta le descrizioni delle opzioni in Aggiungere un'API.
6. Fai clic su Salva.

curl

Dopo aver aggiunto un'API, utilizza la chiamata update per apportare modifiche.

Questo esempio illustra i passaggi necessari per modificare lo stato pubblicato della tua API nel tuo portale da true a false. Se necessario, puoi modificare più di un'impostazione in una chiamata API.

1. Per individuare il valore id generato che identifica in modo univoco ogni API, ottieni un elenco delle API nel tuo portale come descritto in Esplorare le API.

2. Restituisce i valori correnti per un'API specifica:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
   -H "Authorization: Bearer ACCESS_TOKEN"
   

   Sostituisci quanto segue:

   • ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
   • SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
   • API_DOC con il id generato del documento. Ad esempio, 399668. Utilizza il comando list API docs per trovare questo valore.
   • ACCESS_TOKEN con il token di autenticazione utilizzato per accedere all'API Apigee Edge. Per ulteriori informazioni su autenticazione e token, vedi Autenticare l'accesso all'API Edge.

   Payload della risposta:

   {
     "status": "success",
     "message": "apidoc returned",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": false,
       "visibility": false,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729635493000,
       "anonAllowed": false,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": false,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "601210268",
     "error_code": null
   }
   

1. Includi i valori mutabili che vuoi conservare nella chiamata update e modifica quelli che vuoi cambiare. Se ne ometti una, viene utilizzata l'impostazione predefinita. Per questo esempio, modifica l'impostazione pubblicata da false a true:

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "anonAllowed": true,
       "published": true
    }'
   

   Sostituisci quanto segue:

   • TITLE con il nome visualizzato. Ad esempio, Hello World 2.

   Payload della risposta:

   {
     "status": "success",
     "message": "ApiDoc updated",
     "data": {
       "id": 662423,
       "siteId": "my-org-myportal",
       "title": "My Test Catalog 4",
       "description": "",
       "published": true,
       "visibility": true,
       "apiId": "uxb9wjua",
       "apiProductName": "uXB9wJUa",
       "edgeAPIProductName": "uXB9wJUa",
       "specId": null,
       "specContent": null,
       "specTitle": null,
       "snapshotExists": false,
       "snapshotModified": null,
       "modified": 1729989250000,
       "anonAllowed": true,
       "imageUrl": null,
       "snapshotState": null,
       "requireCallbackUrl": false,
       "categoryIds": [],
       "specFormat": null,
       "specModified": null,
       "snapshotOutdated": null,
       "snapshotSourceMissing": false,
       "graphqlSchema": null,
       "graphqlEndpointUrl": null,
       "graphqlSchemaDisplayName": null,
       "grpcFileName": null,
       "grpcZipContent": null
     },
     "code": null,
     "request_id": "738172002",
     "error_code": null
   }
   

UI

Per pubblicare o annullare la pubblicazione di un'API sul tuo portale:

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Fai clic su Modifica.
5. In Dettagli API, seleziona o deseleziona Pubblicata (indicata nel catalogo) per pubblicare o annullare la pubblicazione dell'API sul tuo portale.
6. Fai clic su Salva.

curl

Includi uno dei seguenti elementi nella chiamata di aggiornamento:

"published": true,    # API is published to your portal
"published": false,   # API is not published in your portal

Per modificare l'API:

1. Restituire i valori correnti:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs" \
   -H "Authorization: Bearer ACCESS_TOKEN"

2. Utilizza la chiamata update per modificare l'API. Includi i valori mutabili che vuoi conservare e modifica i valori che vuoi modificare. Se ometti un'impostazione mutabile, viene sovrascritta con il valore predefinito.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/  ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
       "title": "TITLE",
       "description": "DESCRIPTION",
       "anonAllowed": ANON_TRUE_OR_FALSE,
       "imageUrl": IMAGE_URL,
       "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
       "categoryIds": [
         "CATEGORY_ID1",
        "CATEGORY_ID2"
       ],
       "published": PUBLISHED_TRUE_OR_FALSE
   }

Per un esempio dettagliato dei passaggi, delle variabili e del payload restituiti, consulta Gestire la versione del documento.

UI

Per gestire la visibilità di un'API nel tuo portale:

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Fai clic su Modifica.

5. Seleziona l'impostazione di visibilità. Se hai partecipato alla versione beta della funzionalità dei segmenti di pubblico, seleziona una delle seguenti opzioni:

   • Pubblica (visibile a chiunque) per consentire a tutti gli utenti di visualizzare la pagina.
   • Utenti autenticati per consentire solo agli utenti registrati di visualizzare la pagina.
   • Segmenti di pubblico selezionati per selezionare i segmenti di pubblico specifici che devono poter visualizzare la pagina. Consulta Gestire i segmenti di pubblico per il tuo portale.
   In caso contrario, seleziona una delle seguenti opzioni:
   • Utenti anonimi per consentire a tutti gli utenti di visualizzare la pagina.
   • Utenti registrati per consentire solo agli utenti registrati di visualizzare la pagina.

6. Fai clic su Invia.

curl

Se hai partecipato alla versione beta della funzionalità di gestione dei segmenti di pubblico, utilizza la UI per gestire i segmenti di pubblico.

Se non hai eseguito la registrazione alla funzionalità di gestione dei segmenti di pubblico, la visibilità viene gestita utilizzando anonAllowed.

Includi una delle seguenti opzioni nella chiamata update:

  # When not enrolled in the beta release of the audience management feature:

  "anonAllowed": true,      # Anonymous users can see the API
  "anonAllowed": false,     # Only registered users can see the API

Per modificare l'API:

1. Restituire i valori correnti:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Utilizza la chiamata update per modificare l'API. Includi i valori mutabili che vuoi conservare e modifica quelli che vuoi cambiare. Se ometti un'impostazione mutabile, viene utilizzato il valore predefinito.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Consulta Modificare un'API per un esempio dettagliato dei passaggi, delle variabili e del payload restituiti.

UI

Per gestire l'URL di callback per un'API:

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Fai clic su Modifica.
5. In Dettagli API, seleziona o deseleziona la casella di controllo Richiedi agli sviluppatori di specificare un URL di callback.
6. Fai clic su Salva.

curl

Includi una delle seguenti opzioni nella chiamata update:

  "requireCallbackUrl": true,    # Portal user is required to input a URL
  "requireCallbackUrl": false,   # Portal user is not required to input a URL

Per modificare l'API:

1. Restituire i valori correnti:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Utilizza la chiamata update per modificare l'API. Includi i valori mutabili che vuoi conservare e modifica quelli che vuoi cambiare. Se ometti un'impostazione mutabile, viene utilizzato il valore predefinito.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Consulta Modificare un'API per un esempio dettagliato dei passaggi, delle variabili e del payload restituiti.

UI

Per gestire l'immagine di una scheda API:

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Fai clic su Modifica.

5. In Dettagli API:

   • Fai clic su Seleziona immagine per specificare o caricare un'immagine se non ne è selezionata nessuna.
   • Fai clic su Cambia immagine per specificare o caricare un'altra immagine.
   • Fai clic su x nell'immagine per rimuoverla.

   Quando specifichi un'immagine, specifica un'immagine con un URL esterno utilizzato per l'elemento del catalogo o un percorso per i file immagine archiviati nel portale, ad esempio /files/book-tree.jpg. Quando specifichi l'URL di un'immagine esterna, l'immagine non verrà caricata nelle tue risorse. Inoltre, il caricamento dell'immagine nel portale integrato sarà soggetto alla sua disponibilità, che potrebbe essere bloccata o limitata dalle norme sulla sicurezza dei contenuti.

6. Fai clic su Salva.

curl

Includi quanto segue nella chiamata update:

  # Omit line for no image file

  "imageUrl": "IMAGE_URL"    # URL of the external image or name of the image file

Per modificare l'API:

1. Restituire i valori correnti:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Utilizza la chiamata update per modificare l'API. Includi i valori mutabili che vuoi conservare e modifica quelli che vuoi cambiare. Se ometti un'impostazione mutabile, viene utilizzato il valore predefinito.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Consulta Modificare un'API per un esempio dettagliato dei passaggi, delle variabili e del payload restituiti.

UI

Per assegnare un tag a un'API per le categorie durante la modifica:

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Fai clic su Modifica.
5. Fai clic all'interno del campo Categorie ed esegui uno dei seguenti passaggi:
   • Seleziona una categoria dall'elenco a discesa.
   • Aggiungi una nuova categoria digitandone il nome e premendo Invio. La nuova categoria verrà aggiunta alla pagina Categorie e resa disponibile quando aggiungi o modifichi altre API.
6. Ripeti l'operazione per taggare l'API in altre categorie.
7. Fai clic su Salva.

curl

Includi quanto segue nella chiamata update:

  # Omit line for no categories

  "categoryIds": [
      "CATEGORY_ID1",      # A category ID number
      "CATEGORY_ID2"       # A category ID number
    ],

Utilizza il comando list categories per ottenere i numeri ID categoria.

Per modificare l'API:

1. Restituire i valori correnti:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Utilizza la chiamata update per modificare l'API. Includi i valori mutabili che vuoi conservare e modifica quelli che vuoi cambiare. Se ometti un'impostazione mutabile, viene utilizzato il valore predefinito.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Consulta Modificare un'API per un esempio dettagliato dei passaggi, delle variabili e del payload restituiti.

UI

Per modificare il titolo e la descrizione visualizzati:

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Fai clic su Modifica.
5. Modifica i campi Titolo visualizzato e Descrizione visualizzata, se necessario.
6. Fai clic su Salva.

curl

Includi quanto segue nella chiamata update:

  "title": "TITLE",    # Display title
  "description": "DESCRIPTION",  # Display description

Per modificare l'API:

1. Restituire i valori correnti:

   curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN"
   

2. Utilizza la chiamata update per modificare l'API. Includi i valori mutabili che vuoi conservare e modifica quelli che vuoi cambiare. Se ometti un'impostazione mutabile, viene utilizzato il valore predefinito.

   curl -X PUT "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
        -H "Authorization: Bearer ACCESS_TOKEN" \
        -H "Content-Type: application/json" \
        -d '{
           "title": "TITLE",
           "description": "DESCRIPTION",
           "anonAllowed": ANON_TRUE_OR_FALSE,
           "imageUrl": IMAGE_URL,
           "requireCallbackUrl": CALLBACK_TRUE_OR_FALSE,
           "categoryIds": [
             "CATEGORY_ID1",
             "CATEGORY_ID2"
           ],
           "published": PUBLISHED_TRUE_OR_FALSE
        }'

Consulta Modificare un'API per un esempio dettagliato dei passaggi, delle variabili e del payload restituiti.

UI

Per rimuovere un'API dal tuo portale:

1. Accedi al catalogo delle API.
2. Seleziona le API, se non sono già selezionate.
3. Posiziona il cursore del mouse sull'API nell'elenco per visualizzare il menu delle azioni.
4. Fai clic su Elimina.

curl

Per rimuovere un'API dal tuo portale:

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
• API_DOC con il id generato del documento. Ad esempio, 399668. Utilizza il comando list API docs per trovare questo valore.
• ACCESS_TOKEN con il token di autenticazione utilizzato per accedere all'API Apigee Edge. Per ulteriori informazioni su autenticazione e token, vedi Autenticare l'accesso all'API Edge.

Payload della risposta:

{
  "status": "success",
  "message": "Apidoc deleted",
  "data": {
  },
  "code": null,
  "request_id": "1790036484",
  "error_code": null
}

UI

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Controlla lo stato dello snapshot. Se non è aggiornato, viene visualizzato il seguente messaggio:
5. Fai clic su edit Modifica.
6. Esegui una delle seguenti operazioni:
   • Per aggiornare uno snapshot di un documento OpenAPI non aggiornato, fai clic su Aggiorna snapshot.
   • Per modificare il documento utilizzato per generare la documentazione per l'API, fai clic su Seleziona documento nella documentazione dell'API e seleziona il nuovo documento.
7. Nel riquadro Documentazione dell'API, seleziona una delle seguenti opzioni:
   • Documento OpenAPI
   • Schema GraphQL
8. Fai clic su Seleziona documento e seleziona la versione più recente del documento.
9. Per GraphQL, specifica l'URL endpoint.
10. Fai clic su Salva.

La documentazione di riferimento dell'API viene visualizzata nel documento e aggiunta alla pagina Riferimento API. Lo stato dello snapshot viene aggiornato all'attuale:

curl

Per aggiornare i contenuti della documentazione OpenAPI o GraphQL:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"oasDocumentation": {
           "spec":{ "displayName":"DISPLAY_NAME",
                    "contents":"CONTENTS"}
            }
        }'

{
 "status":"success",
 "message":"Api documentation updated",
 "requestId":"645138278"
 "data": {
   "oasDocumentation": {
     "spec": {
        "displayName": "Hello World 2"
      },
     "Format": "YAML"
   }
 }
}

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
  -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"graphqlDocumentation": {
         "schema":{"displayName":"DISPLAY_NAME",
         "contents":"CONTENTS"},
         "endpointUri": "ENDPOINT_URI"
          }
      }'

{
"status": "success",
"message": "ApiDocDocumentation updated",
"data": {
  "oasDocumentation": null,
  "graphqlDocumentation": {
    "schema": {
      "displayName": "schema.docs.graphql",
      "contents": ""
    },
    "endpointUri": "https://demo.google.com/graphql"
  }
},
"code": null,
"request_id": "640336173",
"error_code": null
}

UI

curl

Per scaricare la documentazione dell'API utilizzando get documentation:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.

• API_DOC con il id generato del documento. Ad esempio, 399668. Utilizza il comando list API docs per trovare questo valore.

  Payload della risposta:

{
  "status": "success",
  "message": "ApiDocDocumentation returned",
  "data": {
    "oasDocumentation": {
      "spec": {
        "displayName": "mock",
        "contents": "b3BlbmFwaTogMy4wLjAKaW5mbzoKICBkZXNjcmlw ..."
      },
      "format": "YAML"
    },
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "269996898",
  "error_code": null
}

Dove:

contents: la stringa con codifica Base64 dei contenuti della documentazione dell'API.

UI

1. Accedi al catalogo delle API.
2. Fai clic sulla scheda API, se non è già selezionata.
3. Fai clic sulla riga dell'API che vuoi modificare.
4. Fai clic su edit Modifica.
5. Nel riquadro Documentazione dell'API, seleziona Nessuna documentazione.
6. Fai clic su Salva.

curl

Per cancellare i contenuti esistenti, utilizza l'API update:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apidocs/API_DOC/documentation" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{}'

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
• API_DOC con il id generato del documento. Ad esempio, 399668. Utilizza il comando list API docs per trovare questo valore.

Payload della risposta:

{
  "status": "success",
  "message": "ApiDocDocumentation updated",
  "data": {
    "oasDocumentation": null,
    "graphqlDocumentation": null
  },
  "code": null,
  "request_id": "304329676",
  "error_code": null
}

UI

Per visualizzare la pagina Categorie:

1. Seleziona Pubblica > Portali e seleziona il tuo portale.
2. Fai clic su Catalogo API nella home page del portale.

   In alternativa, puoi selezionare Catalogo API nel menu a discesa del portale nella barra di navigazione in alto.

3. Fai clic sulla scheda Categorie.

La scheda Categorie nel catalogo API mostra l'elenco delle categorie che sono state definite per il tuo portale.

Come evidenziato nella figura precedente, la pagina API ti consente di:

• Visualizza le categorie e le API a cui sono assegnati i tag
• Aggiungi una categoria
• Modificare una categoria
• Eliminare una categoria
• Gestisci le API pubblicate nel tuo portale. Consulta Esplorare il catalogo di API

curl

Per elencare le categorie:

curl -X GET "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN"

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
• ACCESS_TOKEN con il token di autenticazione utilizzato per accedere all'API Apigee Edge. Per ulteriori informazioni su autenticazione e token, vedi Autenticare l'accesso all'API Edge.

Payload della risposta:

{
  "status": "success",
  "message": "all ApiCategory items returned",
  "data": [
    {
      "id": "e0518597-ece2-4d7d-ba7c-d1793df0f8db",
      "siteId": "my-org-myportal",
      "name": "My Category"
    },
    {
      "id": "61c1014c-89c9-40e6-be3c-69cca3505620",
      "siteId": "my-org-myportal",
      "name": "test2"
    }
  ],
  "code": null,
  "request_id": "1263510680",
  "error_code": null
}

Dove:

• id: l'ID dell'elemento della categoria. Ad esempio, 61c1014c-89c9-40e6-be3c-69cca3505620.

UI

Per aggiungere manualmente una categoria:

1. Accedi alla pagina Categorie.
2. Fai clic su + Aggiungi.
3. Inserisci il nome della nuova categoria.
4. Facoltativamente, seleziona una o più API da taggare alla categoria.
5. Fai clic su Crea.

curl

Per aggiungere una categoria:

curl -X POST "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
• ACCESS_TOKEN con il token di autenticazione utilizzato per accedere all'API Apigee Edge. Per ulteriori informazioni su autenticazione e token, vedi Autenticare l'accesso all'API Edge.
• CATEGORY_NAME con il nome della categoria. Ad esempio, demo-backend.

Payload della risposta:

{
  "status": "success",
  "message": "API category created",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend"
  },
  "code": null,
  "request_id": "363146927",
  "error_code": null
}

UI

Per modificare una categoria:

1. Accedi alla pagina Categorie.
2. Fai clic su Modifica.
3. Modifica il nome della categoria.
4. Aggiungi o rimuovi i tag API.
5. Fai clic su Salva.

curl

Per modificare una categoria:

curl -X PATCH "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID"  \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "CATEGORY_NAME" }'

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
• CATEGORY_ID con l'ID della categoria. Ad esempio, bf6505eb-2a0f-47af-a00a-ded40ac72960. Separa più ID categoria con una virgola. Ottieni l'ID categoria con il comando list API categories.
• ACCESS_TOKEN con il token di autenticazione utilizzato per accedere all'API Apigee Edge. Per ulteriori informazioni su autenticazione e token, vedi Autenticare l'accesso all'API Edge.
• CATEGORY_NAME con il nome della categoria. Ad esempio, demo-backend.

Payload della risposta:

{
  "status": "success",
  "message": "ApiCategory updated",
  "data": {
    "id": "61de810e-b48b-4cc1-8f22-959038aadcce",
    "siteId": "my-org-myportal",
    "name": "demo-backend-test"
  },
  "code": null,
  "request_id": "1976875617",
  "error_code": null
}

UI

Per eliminare una categoria:

1. Accedi alla pagina Categorie.
2. Posiziona il cursore del mouse sulla categoria che vuoi modificare per visualizzare il menu delle azioni.
3. Fai clic su Elimina.
4. Fai clic su Elimina per confermare.

curl

Per eliminare una categoria:

curl -X DELETE "https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/sites/SITE_ID/apicategories/CATEGORY_ID" \
    -H "Authorization: Bearer ACCESS_TOKEN" \
    -H "Content-Type: application/json"

Sostituisci quanto segue:

• ORG_NAME con il nome dell'organizzazione. Ad esempio, my-org.
• SITE_ID con il nome del portale, nel formato ORG_NAME-PORTAL_NAME, dove ORG_NAME è il nome dell'organizzazione e PORTAL_NAME è il nome del portale convertito in minuscolo e con spazi e trattini rimossi. Ad esempio, my-org-myportal.
• CATEGORY_ID con l'ID della categoria. Ad esempio, bf6505eb-2a0f-47af-a00a-ded40ac72960. Ottieni l'ID categoria con il comando list API categories.
• ACCESS_TOKEN con il token di autenticazione utilizzato per accedere all'API Apigee Edge. Per ulteriori informazioni su autenticazione e token, vedi Autenticare l'accesso all'API Edge.

Payload della risposta:

{
  "status": "success",
  "message": "ApiCategory deleted",
  "data": {
  },
  "code": null,
  "request_id": "2032819627",
  "error_code": null
}