Log delle modifiche

Questo log delle modifiche evidenzia le modifiche significative alla Guida alla progettazione delle API.

2024-10

  • Le pagine di progettazione sono state reindirizzate alle AIP di Google, ad eccezione della struttura della directory e delle convenzioni di denominazione.

2021-12

  • È stata modificata la terminologia API di rete in API di rete per garantire la coerenza con https://google.aip.dev/9.

2021-09

  • Documenta sia il formato di errore dell'API Google v1 che v2.

2021-04

  • È stata introdotta la gestione delle versioni in base alla visibilità.

  • È stato introdotto il titolo dell'API nel glossario.

2021-03

  • È stata aggiunta l'annotazione per i campi solo di output.

  • Aggiorna le indicazioni per i valori dell'enum in modo da includere sempre un valore _UNSPECIFIED esplicito.

  • Aggiunta indicazioni su come generare e analizzare i nomi delle risorse.

  • Aggiungi progress_percent ai campi standard.

2021-02

  • Sono state aggiunte indicazioni sui campi primitivi optional di proto3.

2021-01

  • È stata aggiornata la pagina Errori per includere l'ultimo miglioramento relativo a google.rpc.ErrorInfo e google.api.ErrorReason.

  • Sono state aggiunte indicazioni su come utilizzare oauth2l, curl e i parametri di sistema per risolvere i problemi relativi agli errori con le API di Google.

  • È stata aggiunta una spiegazione del codice di errore 502 alla pagina Errori. Si tratta di un errore di rete anziché di un errore dell'API.

2020-12

  • I nomi dei pacchetti devono utilizzare nomi di componenti singolari per garantire la coerenza a livello globale. I nomi dei pacchetti non devono contenere trattini bassi.

2020-09

  • Sono stati semplificati alcuni requisiti per le descrizioni dei campi. Sono stati modificati alcuni utilizzi di "deve" al di fuori del documento RFC 2119 in modo che siano conformi alle direttive "deve" del documento RFC 2119.

  • È stato rimosso il campo standard bool deleted a favore di google.protobuf.Timestamp delete_time (già presente nell'elenco).

2020-07

  • Aggiornamento di documentation.md in modo che corrisponda a https://google.aip.dev/192#formatting. Le tabelle Markdown e l'HTML non elaborato non devono essere utilizzati nei commenti proto.

  • È stato aggiunto ErrorInfo per la gestione degli errori.

  • Sono stati aggiunti payload di grandi dimensioni per i pattern di progettazione.

2020-04

  • Nel glossario, le API cloud sono state rinominate in API Google Cloud.
  • Sono state introdotte le API e i servizi come sinonimi di servizio API.

2020-02

  • È stato aggiornato il sistema di versionamento per aggiungere due strategie di versionamento (basate su canale e su release), rimuovere le indicazioni sulle versioni point e modificare il modo in cui facciamo riferimento al versionamento semantico.

2020-01

  • Aggiungi la conservazione dei dati ai pattern di progettazione.

2019-11

  • Aggiungi la terminologia delle API Cloud al glossario.
  • Consiglia ai clienti di riprovare solo per gli errori UNAVAILABLE.

2019-06

  • Aggiungi "Bool vs Enum vs String" ai pattern di progettazione.

2019-03

  • Aggiungi i parametri di sistema ai campi standard.

2019-02

  • Aggiungi nomi basati sul dominio ai pattern di progettazione.

2018-03

  • Aggiungi la semantica di chiusura parziale in streaming ai pattern di progettazione.

2018-02

  • Aggiungi read_time ai campi standard.

2018-01

  • Aggiungi il riferimento allo schema per la definizione del servizio API.

2017-12

  • La versione principale dell'API deve essere l'ultimo componente del nome del pacchetto proto.

2017-11

  • Spiega perché il metodo Create prende una risorsa di input.
  • Chiarisci gli ID raccolta che non hanno una forma plurale, ad esempio prove e meteo.
  • Aggiungi una risorsa singleton ai pattern di progettazione.
  • Chiarire le convenzioni di denominazione di C# per acronimi e versioni.

2017-09

  • Aggiungi mime_type ai campi standard.
  • Aggiungi expire_time ai campi standard.
  • Aggiungi start_time e end_time ai campi standard.

2017-02

  • Aggiungi "Endpoint API" al glossario.
  • Aggiungi update_mask ai campi standard.
  • Aggiungi un link a FieldMask ai metodi standard.
  • Menziona che la specifica OpenAPI non supporta gli interi non firmati.
  • Chiarisci che i nomi dei metodi devono utilizzare i verbi al modo imperativo.