API bez rezultāta un API ar kļūdu prasa divādu apstrādi. Veiksmīga meklēšana var neatrast nevienu vietu pieprasītajā teritorijā. Savukārt tīkla kļūme, sasniegts limits vai nepieejams avots neļauj secināt, pamatojoties uz meklēšanu.
ROOTE gadījumā pārbaudiet HTTP atbildi, pēc tam biznesa statusu, gaidāmo kolekciju un pārklājumu. Šī pieeja novērš situāciju, ka tiek rādīts "nav tualetes", kad pakalpojuma izsaukums neizdodas, vai "nav pieturas" pēc gaidīšanas termiņa pārsniegšanas.
Lasīt trīs atbildes līmeņus
| Līmenis | Jāpārbauda | Iespējamais secinājums |
|---|---|---|
| Transports | Savienojums, laiks un HTTP statuss | Vai pieprasījums izdevās? |
| Līgums | Derīgs JSON, versija un gaidītie lauki | Vai atbilde ir izmantojama? |
| Biznesa rezultāts | statuss, kolekcijas, pārklājums, brīdinājumi un meta | Ko zinām prasītajā teritorijā? |
HTTP kods 200 nepietiek, lai apstiprinātu meklēšanu. Atbilde var norādīt par daļēju izpildi vai kļūdas statusu. Savukārt 404 maršrutā nav normāls veids, kā izteikt tukšu kolekciju: pārbaudiet URL un līgumu.
Sapratne par success, empty, partial un error
| Statuss | Ieteicamā apstrāde |
|---|---|
| success | Parādīt vienības pēc validācijas un saglabāt limitus |
| empty | Norādīt, ka šai meklēšanai nav rezultāta |
| partial | Parādīt izmantojamu informāciju ar brīdinājumiem |
| error | Norādīt meklēšanu kā nepieejamu; neveidot secinājumu par vietu neesamību |
Rezultāta neesamība attiecas uz zināmu pieprasījumu un avotiem. Tā nepierāda pakalpojumu fizisku neesamību. Nepilnīga pārklājuma, ierobežojoša filtra vai pielietota limita dēļ rezultāti var būt samazināti.
Lēmumu koks jūsu saskarnei
1. La requête a-t-elle abouti ?
Non → indisponibilité réseau ou délai dépassé.
2. Le statut HTTP est-il acceptable selon le contrat ?
Non → traiter le code et le message d'erreur.
3. Le JSON respecte-t-il le schéma attendu ?
Non → réponse inexploitable, jamais "aucun résultat".
4. Le statut métier est-il error ?
Oui → recherche indisponible.
5. Le statut est-il partial ou la couverture limitée ?
Oui → résultats utilisables + avertissement.
6. La collection attendue est-elle vide ?
Oui → aucun résultat retourné dans ce périmètre.
Non → afficher les résultats et leurs limites.Pārbaudiet parametrus pareizā secībā
Vispirms pārbaudiet platumu, garumu, to kārtību un iegūto pilsētu. Tad pārbaudiet rādiusa vienību un filtru vārdnīcu. Pakalpojumu API izmanto types=toilets; kartes URL lieto modes=toilets. Šie parametri pieder dažādiem līgumiem.
Tad paplašiniet vienu dimensiju vienlaikus: palieliniet rādiusu maršruta robežās vai noņemiet filtru, lai veiktu izteiktu testu. Saglabājiet sākotnējo pieprasījumu. Ja paplašināt automātiski, informējiet lietotāju par jauno teritoriju.
Izveidot API meklēšanu, pamatojoties uz GPS koordinātām
Apstrādāt nepieejamu avotu, nezaudējot citus
Daļēja atbilde var saturēt vietas no avotiem, kas atbildēja, kamēr cits avots neizdevās. Saglabājiet šos rezultātus, to piešķīrumus un atbilstošo brīdinājumu. Nenorādiet sarakstu kā pilnīgu un neaizstājiet trūkstošos laukus ar maldinošām noklusējuma vērtībām.
Veca informācija kešatmiņā var arī būt noderīga, ja jūsu politika atļauj šādu atsvaru. Tai jābūt identificētai kā vecai. Jūsu pieprasījuma saņemšanas laiks neatjauno sākotnējā novērojuma vecumu.
Pielāgot ziņojumus un atkārtot
| Situācija | Ziņojums, kas jāpielāgo jūsu saskarnei | Darbība |
|---|---|---|
| empty | Šajā zonā ar šiem filtriem nav rezultātu | Mainīt zonu vai filtrus |
| partial | Ir pieejami daži rezultāti; meklēšana nav pabeigta | Parādīt rezultātus un brīdinājumu |
| Validācijas kļūda | Meklēšanā ir nederīgs parametrs | Labot pieprasījumu |
| Autentifikācija vai tiesības | Šim piekļuvei šī meklēšana nav atļauta | Pārbaudīt kontu vai tokenu |
| Limits vai nepieejamība | Meklēšana ir pagaidu nepieejama | Ievērot atkārtošanas norādījumus |
Pie 429 skatiet pakalpojuma norādījumus un iespējamu Retry-After. Kļūda 400 liek koriģēt argumentus; vienas un tās pašas pieprasījuma atkārtošana to neatrisina. Nepārvērtējiet 401 par automātisku anonīmu izsaukumu, ja lietotājs ir sniedzis tokenu.
Pārbaudiet četrus stāvokļus pirms publicēšanas
Sagatavojiet pilnas, tukšas, daļējas un kļūdu atbildes, kā arī nederīgu JSON un laika pārsniegšanu. Pārbaudiet rādīto ziņojumu, saglabātos rezultātus un atkārtoto reižu skaitu. Galvenais tests ir, lai kļūme nekad neradītu apgalvojumu par pakalpojumu neesamību.
Pielietot šīs vadlīnijas mākslīgā intelekta palīgam
Izprast mobilitātes datu formātus
Biežāk uzdotie jautājumi
Vai tukšs saraksts pierāda tualešu neesamību?
Nē. Tas tikai norāda, ka no šīs meklēšanas un pārbaudītajiem avotiem nav saņemts rezultāts.
Vai drīkst rādīt daļēju atbildi?
Jā, ja izmantotās vienības ir derīgas un ja saglabā brīdinājumus un nepieciešamos limitus.
Vai katru kļūdu vajag atkārtot?
Nē. Labojiet parametru vai piekļuves kļūdas; ierobežojiet atkārtojumus pagaidu incidentu gadījumos un ievērojiet pakalpojuma norādījumus.