Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
In diesem Änderungsprotokoll sind wichtige Änderungen für die API-Designanleitung aufgeführt.
2025-06
Die Namenskonvention für die Seite „Design“ wurde zu Google AIP weitergeleitet.
2024-10
Designseiten wurden zu Google AIPs weitergeleitet, mit Ausnahme von Verzeichnisstruktur und Namenskonventionen.
2021-12
Die Terminologie „Networked API“ wurde in „Network API“ geändert, um sie an https://google.aip.dev/9 anzugleichen.
2021-09
Google API-Fehlerformate v1 und v2 dokumentiert.
2021-04
Versionsbasierte Versionsverwaltung eingeführt.
API-Titel im Glossar eingeführt.
2021-03
Annotation für reine Ausgabefelder hinzugefügt.
Anleitung zu Enum-Werten wurde aktualisiert, damit immer ein expliziter _UNSPECIFIED-Wert angegeben wird.
Anleitung zum Generieren und Parsen von Ressourcennamen hinzugefügt.
progress_percent wurde zu Standardfeldern hinzugefügt.
2021-02
Anleitung für optional einfache proto3-Felder hinzugefügt.
2021-01
Seite "Fehler" mit der neuesten Verbesserung in Bezug auf google.rpc.ErrorInfo und google.api.ErrorReason aktualisiert.
Anleitung zur Verwendung von oauth2l, curl und Systemparametern zur Behebung von Fehlern bei Google APIs hinzugefügt.
Erläuterung zum Fehlercode 502 zur Seite "Fehler" hinzugefügt. Dies ist ein Netzwerk- und kein API-Fehler.
2020-12
Paketnamen müssen für eine globale Konsistenz durch einen einzigen Komponentennamen angegeben werden.
Paketnamen dürfen keine Unterstriche enthalten.
2020-09
Einige Anforderungen an Feldbeschreibungen wurden bereinigt. Die Verwendung von „muss“ außerhalb von RFC 2119 wurde zu „sollte“-Anweisungen in RFC 2119 geändert.
Das Standardfeld bool deleted wurde zugunsten von google.protobuf.Timestamp delete_time (bisher bereits aufgeführt) entfernt.
2020-07
Die Datei documentation.md wurde aktualisiert und entspricht https://google.aip.dev/192#formatting.
Markdown-Tabellen und Raw-HTML dürfen in Proto-Kommentaren nicht verwendet werden.
ErrorInfo zur Fehlerbehandlung hinzugefügt.
Große Nutzlasten für Designmuster wurden hinzugefügt.
2020-04
Cloud-APIs wurden im Glossar in Google Cloud-APIs umbenannt.
API und Dienst wurden als Synonyme für API-Dienst eingeführt.
2020-02
Die Versionierung wurde aktualisiert, um zwei Versionsstrategien (auf Kanalebene und Releaseebene) hinzuzufügen, Anleitungen zu Punktversionen zu entfernen und die Bezugnahme auf die semantische Versionierung zu ändern.
2020-01
Datenaufbewahrung zu Entwurfsmuster wurden hinzugefügt.
2019-11
Terminologie-Cloud-APIs wurde zum Glossar hinzugefügt.
Clientsempfehlung zur Wiederholung nur bei nicht verfügbaren Fehlern wurden festgelegt.
2019-06
"Bool vs Enum vs String" wurde hinzugefügt, um Muster zu entwerfen.
2019-03
Standardfeldern wurden Systemparameter hinzugefügt
2019-02
Domainbereichsnamen wurden dem Designmustern hinzugefügt
2018-03
Halbgeschlossenes Streaming wurde den Designmustern hinzugefügt.
2018-02
read_time wurde zu Standardfeldern hinzugefügt.
2018-01
Schemareferenz für API-Dienstdefinition wurde hinzugefügt.
2017-12
Es wurde klargestellt, dass die API-Hauptversion die letzte Komponente des Proto-Paketnamens sein muss.
2017-11
Es wurde klargestellt, warum die Methode Create eine Eingaberessource verwendet.
Es wurde klargestellt, dass es Sammlungs-IDs gibt, die keine Pluralform haben, z. B. "Beweismittel" oder "Wetter".
Es wurden Singleton-Ressourcen zu Designmustern hinzugefügt.
Es wurden die C#-Namenskonventionen für Akronyme und Versionen geklärt.
2017-09
mime_type wurde zu Standardfeldern hinzugefügt.
expire_time wurde zu Standardfeldern hinzugefügt.
start_time und end_time wurden zu Standardfeldern hinzugefügt.
2017-02
"API-Endpunkt" wurde zum Glossar hinzugefügt.
update_mask wurde zu Standardfeldern hinzugefügt.
Link zu FieldMask wurde zu Standardmethoden hinzugefügt.
Es wurde darauf hingewiesen, dass die OpenAPI-Spezifikation keine Ganzzahlen ohne Vorzeichen unterstützt.
Es wurde klargestellt, dass Verben in Methodennamen im Imperativ verwendet werden müssen.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-09-08 (UTC)."],[[["\u003cp\u003eThis changelog documents updates to the API Design Guide, including changes to terminology, error handling, and field requirements.\u003c/p\u003e\n"],["\u003cp\u003eRecent changes include redirecting certain design pages to Google AIPs and updating terminology to align with Google API standards.\u003c/p\u003e\n"],["\u003cp\u003eThe guide has undergone modifications to field descriptions, versioning strategies, and the inclusion of standard fields like \u003ccode\u003eread_time\u003c/code\u003e, \u003ccode\u003emime_type\u003c/code\u003e, \u003ccode\u003eexpire_time\u003c/code\u003e, \u003ccode\u003estart_time\u003c/code\u003e, and \u003ccode\u003eend_time\u003c/code\u003e over time.\u003c/p\u003e\n"],["\u003cp\u003eError handling has been improved with updates to \u003ccode\u003egoogle.rpc.ErrorInfo\u003c/code\u003e and \u003ccode\u003egoogle.api.ErrorReason\u003c/code\u003e, along with guidance on troubleshooting errors and the addition of \u003ccode\u003eErrorInfo\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eDesign patterns have been added and enhanced, with examples such as streaming half-close semantics, singleton resources, data retention, and guidance on bool vs enum vs string.\u003c/p\u003e\n"]]],[],null,["# Changelog\n\nThis Changelog highlights notable changes to the\n[API Design Guide](/apis/design).\n\n2025-06\n-------\n\n- Redirected Design page Naming Convention to Google AIP.\n\n2024-10\n-------\n\n- Redirected Design pages to Google AIPs, except for Directory Structure and Naming Conventions.\n\n2021-12\n-------\n\n- Changed terminology Networked API to Network API for consistency with https://google.aip.dev/9.\n\n2021-09\n-------\n\n- Document both Google API error format v1 and v2.\n\n2021-04\n-------\n\n- Introduced visibility-based versioning.\n\n- Introduced API title to glossary.\n\n2021-03\n-------\n\n- Added annotation for output only fields.\n\n- Update enum value guidance to always include an explicit `_UNSPECIFIED`\n value.\n\n- Add guidance on how to generate and parse resource names.\n\n- Add `progress_percent` to standard fields.\n\n2021-02\n-------\n\n- Added guidance on proto3 `optional` primitive fields.\n\n2021-01\n-------\n\n- Updated the Errors page to cover the latest improvement related to\n `google.rpc.ErrorInfo` and `google.api.ErrorReason`.\n\n- Added guidance on how to use `oauth2l`, `curl`, and System Parameters\n to troubleshoot errors with Google APIs.\n\n- Added `502` error code explanation to the Errors page. It is a network\n error instead of an API error.\n\n2020-12\n-------\n\n- Package names should use singlar component names for global consistency. Package names must not use underscores.\n\n2020-09\n-------\n\n- Cleaned up some field description requirements; changed some uses of \"must\"\n outside RFC 2119 to be RFC 2119 \"should\" directives.\n\n- Removed the `bool deleted` standard field, in favor of\n `google.protobuf.Timestamp delete_time` (which was already listed).\n\n2020-07\n-------\n\n- Updated documentation.md to match https://google.aip.dev/192#formatting.\n Markdown tables and raw HTML must not be used in proto comments.\n\n- Added `ErrorInfo` for error handling.\n\n- Added Large Payloads for design patterns.\n\n2020-04\n-------\n\n- Renamed Cloud APIs to Google Cloud APIs in glossary.\n- Introduced API and service as synonyms of API service.\n\n2020-02\n-------\n\n- Updated versioning to add two versioning strategies (channel-based and release-based), remove guidance on point versions, and change how we refer to semantic versioning.\n\n2020-01\n-------\n\n- Add data retention to design patterns.\n\n2019-11\n-------\n\n- Add terminology Cloud APIs to glossary.\n- Recommend clients to retry only for UNAVAILABLE errors.\n\n2019-06\n-------\n\n- Add \"Bool vs Enum vs String\" to design patterns.\n\n2019-03\n-------\n\n- Add system parameters to standard fields.\n\n2019-02\n-------\n\n- Add domain-scoped names to design patterns.\n\n2018-03\n-------\n\n- Add streaming half-close semantics to design patterns.\n\n2018-02\n-------\n\n- Add `read_time` to Standard Fields.\n\n2018-01\n-------\n\n- Add schema reference for API Service Definition.\n\n2017-12\n-------\n\n- Clarify API major version must be the last component of proto package name.\n\n2017-11\n-------\n\n- Clarify why the `Create` method take an input resource.\n- Clarify collection IDs that don't have plural form, such as evidence and weather.\n- Add singleton resource to design patterns.\n- Clarify C# naming conventions for acronyms and versions.\n\n2017-09\n-------\n\n- Add `mime_type` to standard fields.\n- Add `expire_time` to standard fields.\n- Add `start_time` and `end_time` to standard fields.\n\n2017-02\n-------\n\n- Add \"API endpoint\" to glossary.\n- Add `update_mask` to standard fields.\n- Add a link to `FieldMask` to standard methods.\n- Mention that OpenAPI spec does not support unsigned integers.\n- Clarify that method names should use verbs in the imperative mood."]]
