Impostazione delle opzioni avanzate dell'API

Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

In questa pagina viene spiegato come impostare opzioni di configurazione avanzate, come mappature di input e proprietà virtuali, per i provider di tipi. Per ulteriori informazioni sui tipi, leggi la Panoramica dei tipi. Per scoprire di più sui provider di tipi, consulta la Guida di una pagina all'integrazione con Deployment Manager.

Se stai cercando di integrare un'API che non soddisfa i requisiti API definiti da Deployment Manager, puoi utilizzare le mappature di input e le proprietà virtuali per risolvere queste incoerenze. Le mappature di input ti consentono di fornire mappature esplicite dei parametri API in cui esistono ambiguità e proprietà virtuali consentono di esporre proprietà arbitrarie che non esistono nelle API sottostanti. In questo modo puoi semplificare l'input e nascondere le complessità dell'API agli utenti.

L'implementazione di opzioni di configurazione avanzate richiede una conoscenza approfondita dell'API per la quale stai creando il provider del tipo. Poiché ciascuna API può variare notevolmente da una pagina all'altra, questa pagina fornisce indicazioni generali ed esempi, ma non fornisce istruzioni specifiche sulle API.

Prima di iniziare

Scenari comuni che richiedono opzioni di configurazione avanzate

Il nome della proprietà viene riutilizzato con valori diversi

In alcune API, la stessa proprietà o lo stesso nome del parametro possono essere riutilizzati in metodi diversi, ma con valori diversi. Ad esempio, un'API potrebbe specificare che il parametro name per creare una risorsa (richiesta POST) potrebbe avere il valore foo/bar, mentre lo stesso campo name per una richiesta di aggiornamento (PATCH o PUT) potrebbe richiedere il valore foo/bar/baz.

I valori delle proprietà possono essere dedotti dalla risposta API

Alcuni metodi API richiedono un valore generato dal server che viene restituito quando si invia una richiesta GET alla risorsa. Ad esempio, un'API potrebbe richiedere un parametro etag per effettuare richieste di aggiornamento quando si modifica una risorsa. Il valore etag cambia dopo ogni richiesta di modifica, in modo da ottenere il parametro etag attuale eseguendo una richiesta GET alla risorsa, prima di effettuare la richiesta di aggiornamento della risorsa.

Utilizzando le mappature di input, puoi comunicare a Deployment Manager che il campo etag può essere recuperato dalla risorsa API. Deployment Manager esegue automaticamente una richiesta GET per ottenere questo valore quando un utente chiama il metodo specificato nelle mappature di input.

Semplifica l'input utente

Deployment Manager supporta proprietà virtuali, che sono proprietà arbitrarie che puoi esporre agli utenti tramite Deployment Manager per diversi utilizzi. Considera le proprietà virtuali come proprietà non esistenti nell'API sottostante, ma sono variabili arbitrarie il cui valore puoi inserire secondo necessità nelle mappature di input. Ad esempio, immagina che esista una proprietà API che deve essere codificata in Base64 prima che il valore venga inviato all'API sottostante. Invece di chiedere agli utenti di fornire il valore nella codifica Base64, puoi creare una proprietà virtuale che richieda agli utenti il valore di testo normale, quindi codificare il valore con le mappature di input e infine fornire il risultato all'API sottostante.

Specificare le opzioni avanzate

Per specificare le opzioni avanzate, fornisci la proprietà collectionOverrides quando crei la risorsa Provider di tipi e definisci le mappature di input o le proprietà virtuali per ciascuna raccolta API in base alle tue esigenze.

Ad esempio, con l'interfaccia a riga di comando gcloud, puoi fornire opzioni avanzate utilizzando un file YAML e fornire il file YAML con la tua richiesta type-providers create. Un file YAML di esempio potrebbe avere il seguente aspetto:

collectionOverrides:
- collection: /emailAddresses/v1beta/people
  options:
    inputMappings:
    - methodMatch: ^create$
      fieldName: emailAddress.displayName
      value: $.resource.properties.displayName
      location: BODY
    - methodMatch: ^update$
      fieldName: displayName
      value: $.resource.properties.displayName
      location: PATH
    virtualProperties: |
      schema: http://json-schema.org/draft-04/schema#
      type: object
        properties:
          displayName:
            type: string
credential:
  basicAuth:
    user: [USERNAME]
    password: [PASSWORD]

Questa configurazione indica a Deployment Manager:

  • Per il metodo create, cerca il campo denominato emailAddress.displayName nel corpo della risorsa e imposta il valore del campo sull'input dell'utente per la proprietà displayName nella configurazione di Deployment Manager. Pertanto, se un utente imposta la configurazione in questo modo:

     resources:
     - name: example
       type: myproject/emailAddress:/emailAddresses/v1beta/people
       properties:
       - displayName: John Doe
         ...
    

    Deployment Manager imposterà il valore di emailAddress.displayName su John Doe.

  • Per il metodo update, il campo si trova nel percorso della risorsa anziché nel corpo della risorsa, ma viene applicata la stessa mappatura di input.

Specifica le mappature di input

Una mappatura degli input consente di mappare o inserire informazioni per determinati campi API in modo che Deployment Manager possa interagire più facilmente con l'API sottostante, alleggerendo il carico di lavoro degli utenti per comprendere il comportamento sottile delle API.

Utilizza le mappature di input per semplificare il modo in cui gli utenti interagiscono con l'API. Ad esempio, puoi utilizzare le mappature di input per ottenere automaticamente i valori generati dal server, come fingerprint, ID o etag. Ciò consente agli utenti di avere la possibilità di eseguire una richiesta get separata sulla risorsa ogni volta che vogliono effettuare un aggiornamento.

Analogamente, puoi anche utilizzare le mappature di input per gestire situazioni ambigue o poco chiare in cui lo stesso campo API ha valori diversi per metodi diversi. Ad esempio, una richiesta di creazione di una risorsa potrebbe richiedere una proprietà name che l'utente può specificare, ma la stessa API potrebbe richiedere una proprietà name in un formato diverso per i metodi update. Puoi utilizzare le mappature di input per indicare a Deployment Manager quale valore è appropriato per ogni metodo API.

Per specificare le mappature di input per un provider di tipo, fornisci la proprietà options.inputMappings. Puoi definire le mappature di input che si applicano all'intera API oppure puoi fornire esplicitamente mappature di input per ogni raccolta:

# Input mappings for the entire API
"options": {
  "inputMappings": [
      {
          "fieldName": "[NAME]",
          "location":  "[PATH | BODY | QUERY | HEADER]",
          "methodMatch": "[REGEX_MATCHING_CERTAIN_METHODS]",
          "value": "[VALUE_TO_INJECT]"
      },
      {
          "fieldName": "[NAME]",
          "location":  "[PATH | BODY | QUERY | HEADER]",
          "methodMatch": "[REGEX_MATCHING_CERTAIN_METHODS]",
          "value": "[VALUE_TO_INJECT]"
      }
   ]
},
# Input mappings for specific collections
"collectionOverrides": [
    {
        "collection": "[SPECIFIC_COLLECTION]",
        "options": {
            "inputMappings": [
                {
                    "fieldName": "[NAME]",
                    "location": "[PATH | BODY | QUERY | HEADER]",
                    "methodMatch": "[REGEX_MATCHING_CERTAIN_METHODS]",
                    "value": "[VALUE_TO_INJECT]"
                },
                {
                    "fieldName": "[NAME]",
                    "location": "[PATH | BODY]",
                    "methodMatch": "[REGEX_MATCHING_CERTAIN_METHODS]",
                    "value": "[VALUE_TO_INJECT]"
                },
                ...[additional fields if necessary]...
            ]
        }
    }
]

Ciascuna delle parti importanti di questa sintassi è descritta di seguito.

Raccolta

[SPECIFIC_COLLECTION] è la raccolta API per cui si applica questa mappatura dell'input. Ad esempio, se stavi fornendo mappature di input per un documento Google Discovery, come l'API IAM Service Accounts, le raccolte pertinenti sono projects.serviceAccounts e projects.serviceAccountKeys.

Per un'API che utilizza la specifica OpenAPI, il percorso della raccolta potrebbe essere /example-collection/{name}. Puoi esplorare un esempio di API Open funzionante nel repository GitHub di OpenAPI.

Nome campo

"fieldName" è l'attributo API o la proprietà per cui vuoi specificare la mappatura di input. Ad esempio, "fieldName": "fingerprint", "fieldName": "etag" e così via.

Località

Le proprietà dell'API possono apparire come parametri nel percorso dell'URL o come parte del corpo della richiesta o della risposta. Specifica dove si applica questa mappatura di input, ad esempio l'URL PATH o richiedi BODY come posizione. I valori supportati includono:

  • PATH
  • BODY
  • QUERY
  • HEADER

Corrispondenza metodo

Specifica i metodi a cui si applica questa mappatura di input. Utilizza regex per specificare più metodi. Ad esempio:

"methodMatch":"^create$"

Per le specifiche OpenAPI, puoi:

"methodMatch: ^(put|get|delete|post)$"

Valore

Specifica il valore che Deployment Manager deve inserire per questo campo. Questo campo utilizza la notazione JSONPath. Ad esempio, questa mappatura dell'input indica che per il campo name, Deployment Manager deve prendere il valore fornito dall'utente e inserirlo nel formato projects/$.project/topics/$resource.properties.topic:

"inputMappings":[
{
  "fieldName":"name",
  "location":"PATH",
  "methodMatch":"^post$",
  "value":"concat(\"projects/\", $.project, \"/topics/\", $.resource.properties.topic)"
}...
  • Quando utilizzi $.resource.properties.[VARIABLE], imposti un valore su una proprietà che un utente imposterà nella propria configurazione. Ad esempio, per $.resource.properties.topic, il valore sarà il valore fornito dall'utente per la proprietà topic nella sua configurazione:

    resources:
    - name: example
      type: example-type-provider:collectionA
      properties:
        topic: history # The value of "history" would be used for the `name` parameter because of the input mapping above
    
  • Per fare riferimento alla risorsa stessa dopo una richiesta get, utilizza $.resource.self.[VARIABLE]. Ad esempio, per le richieste di aggiornamento, se vuoi recuperare l'ultima impronta, puoi utilizzare questa sintassi per indicare a Deployment Manager di eseguire un get e ottenere il valore:

    {
      'fieldName': 'fingerprint',
      'location': 'BODY',
      'methodMatch': '^(put)$',
      # self represents the resource by doing a GET on it.
      # This mappings gets latest fingerprint on the request.
      # Final PUT Body will be
      # {
      #   "name": "my-resource-name",
      #   "fingerprint": "<server generated fingerprint>"
      # }
      'value': '$.resource.self.fingerprint'
    }
    

Utilizzo delle proprietà virtuali

Le proprietà virtuali sono proprietà arbitrarie che puoi esporre agli utenti tramite Deployment Manager. Queste proprietà non fanno parte dell'API sottostante, ma sono variabili arbitrarie che possono essere utilizzate per trasmettere informazioni o nascondere le incongruenze dell'API agli utenti. Puoi fare riferimento alle proprietà virtuali anche nelle mappature di input.

Le proprietà virtuali seguono lo schema JSON 4. Fornisci proprietà virtuali nell'ambito di options per una collezione specifica:

"collection": "[SPECIFIC_COLLECTION]",
  "options": {
   "virtualProperties": "schema: http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n  [PROPERTY]:\n    type: [DATA_TYPE]\n  [ANOTHER_PROPERTY]:\n    type: [ANOTHER_DATA_TYPE]n"
   "inputMappings": [
    ...
   ]
  }

In un file di definizione YAML, il codice sarà simile al seguente:

- collection: projects.serviceAccounts
  options:
    virtualProperties: |
      schema: http://json-schema.org/draft-04/schema#
      type: object
      properties:
        a-property:
          type : string
        b-property:
          type : string
      required:
      - a-property
      - b-property
    inputMappings:
    ...

Ad esempio, prendi in considerazione un'API falsa che genera indirizzi email. Supponiamo che l'API abbia un metodo per creare un'email che acquisisca una proprietà emailAddress.displayName. Quando un utente invia una richiesta per creare un indirizzo email, fornisce una richiesta simile alla seguente:

POST https://example.com/emailAddresses/v1beta/people/

{
  "emailAddress": {
    "displayName": "john"
  }
}

Supponiamo ora che l'API mostri un modo per aggiornare l'indirizzo email, ma il metodo per aggiornare un'email richiede solo la proprietà displayName, anziché la proprietà email.displayName:

POST https://example.com/emailAddresses/v1beta/people/john

{
  "displayName": "josh"
}

In che modo ti aspetti che gli utenti forniscano questo valore quando utilizzano questo tipo di provider? Puoi chiedere di specificare la proprietà in modo diverso a seconda dell'operazione:

# Creating an email
resources:
- name: example-config
  type: projects/test-project:emailAddresses
  properties:
    emailAddress:
      displayName: john

# Updating an email
resources:
- name: example-config
  type: projects/test-project:emailAddresses
  properties:
    displayName: john

In alternativa, puoi creare una proprietà virtuale che abbia lo stesso valore, indipendentemente dall'operazione, e poi utilizzare le mappature di input per mappare la proprietà virtuale al parametro API appropriato. Per questo esempio, supponiamo che tu abbia definito una proprietà virtuale denominata displayName. Le mappature di input potrebbero avere il seguente aspetto:

{
    "collectionOverrides":[
      {
        "collection":"emailAddresses",
        "options":{
          "inputMappings":[
            {
              "fieldName":"emailAddress.displayName",
              "location":"BODY",
              "methodMatch":"^create$",
              "value":"$.resource.properties.displayName"
            },
            {
              "fieldName":"displayName",
              "location":"BODY",
              "methodMatch":"^update$",
              "value":"$.resource.properties.displayName"
            }
          ],
          "virtualProperties":"schema: http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n  displayName:\n    type: string\nrequired:\n- displayName\n"
        }
      }
    ],
    "descriptorUrl":"https://example.com/emailAddresses/v1beta/",
    "options":{
      "nameProperty":""
    }
}

Nello specifico, la proprietà virtuale è definita qui:

"virtualProperties":"schema: http://json-schema.org/draft-04/schema#\ntype: object\nproperties:\n  displayName:\n    type: string\nrequired:\n- displayName\n"

In un formato leggibile:

"virtualProperties":
  "schema: http://json-schema.org/draft-04/schema#\n
   type: object\n
   properties:\n
     displayName:\n
     - type: string\n
   required:\n
   - displayName\n"

Ora gli utenti possono specificare displayName come proprietà di primo livello sia per le richieste di aggiornamento che per quelle di creazione e Deployment Manager saprà come mappare correttamente il valore.

# Creating an email
resources:
- name: example-config
  type: projects/test-project:emailAddresses
  properties:
    displayName: john

# Updating an email
resources:
- name: example-config
  type: projects/test-project:emailAddresses
  properties:
    displayName: john

Passaggi successivi