Questo log delle modifiche evidenzia le modifiche importanti apportate alla Guida alla progettazione delle API.
2021-12
- Terminologia modificata dall'API Networked all'API Network per la coerenza con https://google.aip.dev/9.
2021-09
- Documenta sia il formato di errore dell'API di Google v1 che v2.
2021-04
È stato introdotto il controllo delle versioni basato sulla visibilità.
Introdotto il titolo dell'API nel glossario.
2021-03
Aggiunta un'annotazione per i campi solo di output.
Aggiorna le indicazioni sul valore di enumerazione in modo che includano sempre un valore
_UNSPECIFIED
esplicito.Aggiungi 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
del proto3.
2021-01
È stata aggiornata la pagina Errori per includere l'ultimo miglioramento relativo a
google.rpc.ErrorInfo
egoogle.api.ErrorReason
.Sono state aggiunte indicazioni su come utilizzare
oauth2l
,curl
e i parametri di sistema per risolvere gli errori delle API di Google.È stata aggiunta la spiegazione del codice di errore
502
alla pagina Errori. È un errore di rete anziché un errore dell'API.
2020-12
- Per la coerenza globale, i nomi dei pacchetti devono utilizzare singoli nomi dei componenti. I nomi dei pacchetti non devono contenere trattini bassi.
2020-09
Sono stati ripuliti alcuni requisiti per le descrizioni dei campi; sono stati modificati alcuni utilizzi di "Must" al di fuori di RFC 2119 per diventare direttive RFC 2119 "Dove".
È stato rimosso il campo standard
bool deleted
a favore digoogle.protobuf.Timestamp delete_time
(già elencato).
2020-07
È stata aggiornata la documentazione.md in modo che corrisponda a quella in https://google.aip.dev/192#formatting. Le tabelle Markdown e il codice HTML non elaborato non devono essere utilizzati nei commenti del proto.
ErrorInfo
aggiunto per la gestione degli errori.Aggiunti payload di grandi dimensioni per i pattern di progettazione.
2020-04
- API Cloud rinominate in API Google Cloud nel glossario.
- Introduzione di API e servizio come sinonimi del servizio API.
2020-02
- Controllo delle versioni aggiornato per aggiungere due strategie di controllo delle versioni (basata sul canale e basata sulla release), rimuovere le indicazioni sulle versioni punti e cambiare il modo in cui facciamo riferimento al controllo delle versioni semantico.
2020-01
- Aggiungere la conservazione dei dati ai pattern di progettazione.
2019-11
- Aggiungere la terminologia delle API Cloud al glossario.
- Si consiglia ai client di riprovare solo per errori UNAVAILBLE.
2019-06
- Aggiungi "Bool vs Enum o String" per progettare pattern.
2019-03
- Aggiungi parametri di sistema ai campi standard.
2019-02
- Aggiungi nomi con ambito di dominio per progettare pattern.
2018-03
- Aggiungi la semantica dei flussi di dati semi-chiudi ai pattern di progettazione.
2018-02
- Aggiungi
read_time
ai campi standard.
2018-01
- Aggiungi 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
- Chiarisci perché il metodo
Create
prende una risorsa di input. - Chiarisci gli ID raccolta che non hanno la forma plurale, ad esempio prove e meteo.
- Aggiungi una risorsa singleton ai pattern di progettazione.
- Chiarire le convenzioni di denominazione C# per gli acronimi e le versioni.
2017-09
- Aggiungi
mime_type
ai campi standard. - Aggiungi
expire_time
ai campi standard. - Aggiungi
start_time
eend_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. - Indica che la specifica OpenAPI non supporta i numeri interi senza segno.
- Chiarisci che i nomi dei metodi devono utilizzare verbi di umore imperativo.