5 pași pentru crearea unei aplicații de succes

Este natura dezvoltării de software. Dezvoltatorii creează software având în vedere utilizatorul final. Pare destul de simplu, dar uneori acești utilizatori sunt și colaboratori. Nu au nevoie de lucruri defalcate pentru ei. Nu au nevoie nici măcar de simplitate. Tot ce doresc este accesul - o modalitate de a integra software-ul cu al lor. Aici intervine o API (interfață de programare a aplicației). Sper să evidențiez cinci pași pe care îi puteți face pentru a crea o API de succes.

Fă-ți tema

Când vine vorba de dezvoltarea de software, niciunul dintre noi nu vrea să reinventeze roata. În acest moment, aproape toate companiile web mari au API-uri pentru produsele lor software. Studiați aceste API și încercați să preluați diferitele decizii de proiectare care au fost create pentru crearea lor.

Există multe tehnologii diferite, dar majoritatea API-urilor pe care le veți vedea vor folosi fie o interfață RESTful, fie SOAP. Dacă sunteți pe gard cu privire la interfața API pe care o veți utiliza, aș sugera să mergeți cu o abordare RESTful folosind protocolul HTTP. Este mai simplu decât SOAP, în prezent este mai popular și va fi mai ușor să începeți când utilizați un produs software bazat pe Web.

Fii consistent

Unul dintre lucrurile pe care dezvoltatorii le apreciază cel mai mult este consistența. Aceasta include, printre altele, adresabilitatea, argumentele de intrare, formatele de ieșire și gestionarea erorilor.

Când utilizați o abordare RESTful, există multe scheme de denumire URI diferite. Fiecare are susținătorii săi, așa că alege doar unul și rămâne cu el. Același lucru este valabil și cu structura de intrare și ieșire. Majoritatea API-urilor acceptă utilizarea XML și JSON ca formate de intrare și ieșire. Aș sugera să sprijiniți ambele, dar alegerea unui format implicit.

Pentru introducere, cerințele de intrare ar trebui să fie denumite în mod constant și ar trebui să aibă sens în contextul apelului API pe care îl efectuați. Pentru ieșire, asigurați-vă că utilizați machete comune de structură a datelor. Dacă înfășurați ieșirea unui apel API într-un Etichetă XML, ia în considerare să faci asta cu celelalte apeluri.

Este o practică comună să includeți un fel de steag de stare în datele de ieșire pe care le trimiteți înapoi clientului. Când se utilizează o abordare API RESTful, aceasta trebuie făcută folosind coduri de stare HTTP. De exemplu, dacă tocmai ați procesat o solicitare PUT pe un obiect de date existent, codul de stare HTTP pe care îl includeți în răspunsul dvs. va varia în funcție de rezultatul solicitării.

În loc de un steag arbitrar care indică starea apelului, se poate utiliza un cod standard de stare „200 OK” pentru a semnifica că solicitarea a avut succes, în timp ce un cod de stare „400 Cerere greșită” poate fi folosit pentru a semnifica că solicitarea a fost format incorect. Există destul de multe coduri de stare HTTP care pot fi utilizate în diferite situații.

Folosiți OAuth

Majoritatea produselor software implică un fel de autentificare a utilizatorului pentru a accesa resurse protejate pentru acel utilizator. Când vine vorba de API-uri, faptul că clientul colectează datele de identificare ale utilizatorului pentru a le trimite serverului dvs. este o practică proastă. Aici intră OAuth.

OAuth oferă multe beneficii în ceea ce privește autentificarea unui nume de utilizator / parolă terță parte. Mai presus de toate, clientul nu are niciodată acces la datele de acreditare ale utilizatorului. Utilizatorul este redirecționat către serverul dvs. când se conectează. După ce utilizatorul se conectează la site-ul dvs., acesta este redirecționat înapoi către client unde clientul va primi un simbol de acces pentru a-l utiliza în viitoarele solicitări la resurse protejate.

Un alt beneficiu important al utilizării OAuth este capacitatea utilizatorului de a anula accesul clientului în orice moment. Dacă utilizatorul decide că, din orice motiv, nu mai dorește ca clientul să poată accesa resurse protejate în numele său, pur și simplu accesează o interfață pe care ai creat-o și anulează accesul clientului.

Începeți devreme

Unul dintre cele mai importante lucruri pe care le puteți face pentru ca API-ul dvs. să devină un succes este să începeți mai devreme. Când scrieți această funcție pentru a crea o intrare în baza de date, mergeți mai departe și luați timpul suplimentar și scrieți o interfață API pentru aceasta.

Scrieți o documentare bună

Nimic nu ucide mai repede o API decât să nu aibă o documentare bună. În timp ce unii dezvoltatori pot lua o API slab documentată și își dau seama cum ar trebui să funcționeze, cei mai mulți nu vor dori.

Ar trebui să documentați fiecare apel API pe care îl aveți disponibil și să clasificați apelurile API în funcție de tipul de date pe care îl acționează. Alături de documentarea obiectivelor pentru apelurile API în sine, ar trebui să definiți sistematic argumentele de intrare necesare și opționale, precum și structurile de date de ieșire. Argumentele de intrare ar trebui să enumere o valoare implicită dacă există una și, de asemenea, să indice formatul de date preconizat, cum ar fi un număr sau un șir. În sfârșit, fiecare apel API ar trebui să aibă o listă de condiții de eroare și coduri de stare.

Pentru a completa documentația, asigurați-vă că includeți unul sau două exemple pentru scenarii comune de intrare și ieșire pentru fiecare apel API.

Dezvoltare API: Keep It Simple

Deși poate părea că dezvoltarea unei API este un efort complicat, ideea unei API în sine nu este un concept nou și există o cantitate mare de documentație disponibilă pentru fiecare subiect pe care l-am abordat aici. Doar asigurați-vă că utilizați bune practici unde le puteți găsi și că oferiți o interfață consistentă, bine documentată.