Impostazione delle opzioni avanzate dell'API

Questa pagina descrive come impostare le opzioni di configurazione avanzate, come le mappature degli input e le proprietà virtuali, per i provider di tipi. Per ulteriori informazioni sui tipi, consulta la Panoramica dei tipi. Per scoprire di più sui provider di tipi, leggi la guida di una pagina per l'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 caso di ambiguità, mentre le proprietà virtuali ti consentono di esporre proprietà arbitrarie che non esistono nelle API sottostanti, in modo da poter semplificare l'input e nascondere le complessità dell'API agli utenti.

L'implementazione di opzioni di configurazione avanzate richiede una certa familiarità con l'API per cui stai creando il provider di tipi. Poiché ogni API può variare notevolmente dalle altre, questa pagina fornisce indicazioni generali ed esempi, ma non fornisce indicazioni specifiche.

Prima di iniziare

Scenari comuni che richiedono opzioni di configurazione avanzate

Il nome della proprietà viene riutilizzato con valori diversi

In alcune API, lo stesso nome di proprietà o parametro potrebbe essere riutilizzato in metodi diversi ma con valori diversi. Ad esempio, un'API potrebbe specificare che il parametro name per la creazione di una risorsa (una 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 dell'API

Alcuni metodi API richiedono un valore generato dal server che viene restituito quando effettui una richiesta GET alla risorsa. Ad esempio, un'API potrebbe richiedere un parametro etag per effettuare richieste di aggiornamento in caso di modifica di una risorsa. Il valore etag cambia dopo ogni richiesta di modifica, quindi ottieni 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 è possibile recuperare il campo etag dalla risorsa API. Deployment Manager esegue automaticamente una richiesta GET per ottenere questo valore quando un utente chiama il metodo che hai 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 usi diversi. Tratta le proprietà virtuali come proprietà che non esistono nell'API sottostante, ma sono variabili arbitrarie il cui valore puoi inserire in base alle 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. Anziché chiedere agli utenti di fornire il valore nella codifica Base64, puoi creare una proprietà virtuale che richieda agli utenti il valore in testo normale, quindi codificare il valore con mapping di input e infine fornire il risultato all'API sottostante.

Specificare le opzioni avanzate

Per specificare le opzioni avanzate, fornisci la proprietà collectionOverrides durante la creazione della risorsa del provider dei tipi e definisci le mappature degli input o le proprietà virtuali per ogni raccolta di API in base alle tue esigenze.

Ad esempio, con gcloud CLI, 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 di quel campo sull'input dell'utente per la proprietà displayName nella configurazione di Deployment Manager. Quindi, se un utente imposta la propria 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 dei mapping di input

Un mapping di input consente di mappare o inserire informazioni per determinati campi API in modo che Deployment Manager possa interagire in modo più fluido con l'API sottostante, alleviando il carico di comprensione del comportamento dell'API per gli utenti.

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 valori generati dal server, come fingerprint, ID o etag. Ciò consente agli utenti di non eseguire una richiesta get separata sulla risorsa ogni volta che vogliono eseguire un aggiornamento.

Allo stesso modo, puoi utilizzare le mappature di input per gestire situazioni ambigue o confusi in cui lo stesso campo API ha valori diversi a seconda dei metodi. Ad esempio, una richiesta per creare 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 ciascun metodo API.

Per specificare le mappature di input per un provider di tipi, fornisci la proprietà options.inputMappings. Puoi definire mappature di input che si applicano all'intera API oppure 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 questo mapping di input. Ad esempio, se fornisci mappature di input per un documento di rilevamento Google, 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 di raccolta potrebbe essere /example-collection/{name}. Puoi esplorare un esempio OpenAPI funzionale nel repository GitHub di OpenAPI.

Nome campo

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

Località

Le proprietà API possono essere visualizzate 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 località. I valori supportati includono:

  • PATH
  • BODY
  • QUERY
  • HEADER

Corrispondenza del metodo

Specifica i metodi a cui si applica questa mappatura dell'input. Usa l'espressione regolare per specificare più metodi. Ad esempio:

"methodMatch":"^create$"

Per le specifiche OpenAPI, puoi fare quanto segue:

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

Valore

Specifica il valore che Deployment Manager deve inserire in questo campo. Questo campo utilizza la notazione JSONPath. Ad esempio, questa mappatura di 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 il valore su una proprietà che verrà impostata da un utente nella sua 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 dopo una richiesta get, utilizza $.resource.self.[VARIABLE]. Ad esempio, per le richieste di aggiornamento, se vuoi ottenere l'ultima fingerprint, puoi utilizzare questa sintassi per indicare a Deployment Manager di eseguire un get e recuperare 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 incongruenze dell'API agli utenti. Puoi fare riferimento anche alle proprietà virtuali nelle mappature di input.

Le proprietà virtuali seguono lo schema JSON 4. Fornisci proprietà virtuali come parte del options per una raccolta 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, sarebbe simile a questo:

- 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, considera un'API falsa che genera indirizzi email. Supponiamo che l'API abbia un metodo per creare un'email che accetta una proprietà emailAddress.displayName. Quando un utente richiede di creare un indirizzo email, fornisce una richiesta come la seguente:

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

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

Ora, supponiamo che l'API mostri un modo per aggiornare l'indirizzo email, ma che il metodo per aggiornare un'email richieda 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 provider di tipi? Potresti chiedere loro 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 quindi 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 viene definita qui:

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

In 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