Carica specifiche API

Questa pagina si applica a Apigee e Apigee ibridi.

Preview — Apigee API hub

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Esistono due modi per aggiungere una specifica API a un'API registrata.

• Carica un file delle specifiche.
• Specifica l'URI di un file di specifica.

Carica una specifica API

Puoi caricare e aggiungere una specifica API a una versione registrata dell'API. Quando carichi una specifica API, l'hub API esegue l'analisi della specifica e aggiorna la nuova risorsa API con i metadati estratti dalla specifica.

Nota: sebbene tu possa caricare specifiche di tipo aaa, bbb, ccc e OpenAPI, l'analisi è supportata solo per le specifiche OpenAPI.

Questo documento spiega come aggiungere una specifica API a una versione dell'API.

Carica una specifica API

Console

1. Nella console Google Cloud, vai alla pagina Hub API.

   Vai all'hub API
2. Fai clic su API.
3. Seleziona l'API registrata che vuoi aggiornare.
4. Fai clic su Add Specification File (Aggiungi file di specifica).
5. Seleziona il file delle specifiche con uno dei seguenti metodi:
   • Nel riquadro File delle specifiche, vai al file delle specifiche che vuoi caricare.
   • Nel campo URL risorsa, inserisci l'URL della specifica che vuoi caricare.
6. Facoltativamente, aggiungi un nome per la specifica.
7. Seleziona la versione API a cui associare il file delle specifiche.
8. Seleziona il tipo di file di specifica, ad esempio GraphQL, REST, YAML e così via.

REST

Per aggiungere una risorsa API con l'API REST:

POST https://apihub.googleapis.com/v1/projects/PROJECT/locations/LOCATION/apis/ID/versions/VERSION/specs?specIdSPEC_ID

    {
      "displayName": "DISPLAYNAME",
      "contents": "SPEC_CONTENTS",
      "mimeType": "MIME_TYPE" 
    {
  

Sostituisci quanto segue:

• PROJECT: il nome del progetto host di API Hub. Il progetto host è stato selezionato quando è stato eseguito il provisioning dell'hub API.
• LOCATION: la posizione del progetto host. La località è stata scelta quando l'API è stato eseguito il provisioning dell'hub.
• ID: (facoltativo) se non fornisci un ID, il sistema ne genera uno per te. La L'ID è l'ultimo componente del nome della risorsa dell'API di sola lettura, che è nel formato: projects/PROJECT/locations/LOCATION/apis/ID
• VERSION: (obbligatorio) la versione della risorsa API.
• SPEC_ID: (facoltativo) un ID per la specifica. Se non fornisci questo parametro di query, viene generato un codice L'ID verrà creato automaticamente.
• DISPLAYNAME: (obbligatorio) il nome visualizzato della specifica dell'API. Puoi utilizzare qualsiasi nome.
• SPEC_CONTENTS: (obbligatorio) i contenuti delle specifiche come stringa con codifica base64. CPC 10 MB. È supportata solo la specifica OpenAPI.
• MIME_TYPE: (obbligatorio) il tipo MIME dei contenuti. Ad esempio, application/json, application/yaml, application/wsdl e così via.

Puoi aggiungere altri attributi facoltativi per l'API includendoli nella richiesta corpo del testo o potrai aggiungerli in un secondo momento. Ad esempio, puoi specificare una descrizione, un proprietario e un link alla documentazione dell'API. Per ulteriori informazioni, consulta l'API hub API.