APIs · SDKs
API-Clients und SDKs konfigurieren
Halten Sie Basis-URLs aus dem Code heraus, lassen Sie sie auf den echten Dienst verweisen und fügen Sie eine Prüfung hinzu, die verhindert, dass Beispieladressen in die Produktion gelangen.
Anleitung · Dokumentation
Dokumentation, Tutorials und Tests brauchen Adressen, Nummern und Namen, die echt aussehen, aber nie jemanden erreichen. Für die meisten Arten von Werten gibt es einen reservierten Bereich. Diese Anleitung listet sie mit der jeweiligen Quelle auf, damit Beispiele harmlos bleiben, wenn jemand sie kopiert.
Beispiele werden kopiert: in Code, Konfigurationsdateien, Tests und andere Dokumentation. Ein Wert, der erfunden aussieht, aber jemandem gehört, schickt diesen Traffic, diese E-Mails oder diese Anrufe an eine reale Partei. example-petstore.com ist ein Beispiel dafür: ein erfundener Name aus der Dokumentation von Google, den jeder registrieren konnte und der bis heute Anfragen erhält. Reservierte Werte werden garantiert nie vergeben, sodass ein kopiertes Beispiel harmlos fehlschlägt.
Verwenden Sie für Websites, APIs und E-Mail-Adressen in Beispielen example.com, example.net oder example.org und deren Subdomains, etwa api.example.com und user@example.com. Für Testumgebungen, Namen, die nie aufgelöst werden dürfen, und lokale Netze gibt es .test, .invalid, .localhost, home.arpa und .internal.
Wofür jeder reservierte Name gedacht ist und warum Doppelgänger wie example-petstore.com nicht sicher sind: Beispieldomains
| Typ | Für Dokumentation reserviert | Quelle |
|---|---|---|
| IPv4 | 192.0.2.0/24 (TEST-NET-1), 198.51.100.0/24 (TEST-NET-2), 203.0.113.0/24 (TEST-NET-3) | RFC 5737 |
| IPv6 | 2001:db8::/32 | RFC 3849 |
| IPv6, größere Netze | 3fff::/20 | RFC 9637 (2024) |
# Ein Client, ein Server und ein Proxy in einem Beispiel
client 192.0.2.10 2001:db8::10
server 198.51.100.20 2001:db8:1::20
proxy 203.0.113.30 2001:db8:2::30
Die drei IPv4-Blöcke geben einem Beispiel drei getrennte „Netze“, was bei der Erklärung von Routing oder Firewalls hilft.
3fff::/20 gibt es, weil 2001:db8::/32 zu klein ist, um realistische Zuteilungen für große Provider
darzustellen.
Für BGP-Beispiele: 64496–64511 (16 Bit) und 65536–65551 (32 Bit),
von RFC 5398 für Dokumentation reserviert. AS-Nummern für den privaten Gebrauch sind für echte Netze gedacht, nicht für
Beispiele.
00-00-5E-00-53-00 bis 00-00-5E-00-53-FF (in den meisten Werkzeugen als
00:00:5e:00:53:00 geschrieben) sind durch RFC 9542 (Nachfolger von RFC 7042) für Dokumentation reserviert.
Einen weltweiten Bereich gibt es nicht; mehrere Länder reservieren eigene Nummern für Fiktion und Beispiele:
555-0100 bis 555-0199 mit beliebiger Vorwahl, etwa
+1 202 555 0143.07700 900000 bis 07700 900999,
London 020 7946 0000 bis 020 7946 0999 und 01632 960000 bis 01632 960999
ohne bestimmte Region.Für andere Länder hilft ein Blick zur jeweiligen Telekommunikations-Regulierungsbehörde. Wo es keinen Bereich gibt, verwenden
Sie einen Platzhalter, der sich nicht wählen lässt, etwa +31 6 XXXX XXXX, statt Ziffern, die nur zufällig aussehen.
Zahlungsanbieter veröffentlichen Testkartennummern, die nur in ihrem Testmodus funktionieren, etwa
4242 4242 4242 4242 von Stripe mit beliebigem zukünftigem Ablaufdatum und beliebiger CVC. Verwenden Sie die
Nummern des Anbieters, den Sie anbinden; Testnummern eines Anbieters werden von einem anderen nicht akzeptiert. Verwenden Sie
niemals eine echte Kartennummer, auch nicht Ihre eigene, in Dokumentation, Fixtures oder Screenshots.
10.0.0.0/8 oder 192.168.0.0/16 in öffentlicher
Dokumentation: Sie existieren im eigenen Netz der Leser, sodass ein kopiertes Beispiel dort ein echtes Gerät erreichen kann.YOUR_API_KEY oder
sk_test_…, niemals einen Schlüssel, der jemals gültig war.