Designing RESTful webservices and web apis
0 likes1,263 views
Documentul discută despre cele mai bune practici în proiectarea serviciilor web RESTful și API-urilor, inclusiv evoluția acestora și diferențele dintre REST și SOAP. Sunt prezentate resursele web, metodele HTTP, structura și bunele practici pentru URI-uri, precum și codurile de răspuns pentru tratarea excepțiilor. În plus, sunt oferite linkuri către resurse suplimentare pentru o înțelegere mai aprofundată a designului API-urilor.
![URI, definiție
● RFC 3986
● Syntaxa unui URI e:
o scheme
o "://"
o authority
o "/" path
o [ "?" query ]
o [ "#" fragment ]
● http://example.com/v1/users#name?
q=Remus
19](https://image.slidesharecdn.com/designingrestfullwebservicesandwebapisremuspereni-130421104832-phpapp02/85/Designing-RESTful-webservices-and-web-apis-19-320.jpg)
![URI / Best practice-uri
Utilizati charactere mici in URI-uri (lowercase)
● https://api.taskmgm.com/v1/users
o o resursa
● HTTP://Api.Taskmgm.com/v1/users
o aceiasi resursa ca mai sus
● https://api.taskmgm.com/v1/Users
o o alta resursa
De ce?
RFC 3896 defineste URI-urile case sensitive exceptind Protocol-ul si
componentele host-ului
scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]
21](https://image.slidesharecdn.com/designingrestfullwebservicesandwebapisremuspereni-130421104832-phpapp02/85/Designing-RESTful-webservices-and-web-apis-21-320.jpg)
![Formate multiple
● Implicit parte din HTTP
● header-ul: Accept
Accept
=
"Accept"
":"
#(
media-‐range
[
accept-‐params
]
)
media-‐range
=
(
"*/*"
|
(
type
"/"
"*"
)
|
(
type
"/"
subtype
)
)
*(
";"
parameter
)
accept-‐params
=
";"
"q"
"="
qvalue
*(
accept-‐extension
)
accept-‐extension
=
";"
token
[
"="
(
token
|
quoted-‐string
)
]
Accept:
text/html,application/xhtml+xml,application/xml;q=0.9,*/
*;
https://api.taskmgm.com/v1/companies?format=json
23](https://image.slidesharecdn.com/designingrestfullwebservicesandwebapisremuspereni-130421104832-phpapp02/85/Designing-RESTful-webservices-and-web-apis-23-320.jpg)
Designing RESTful webservices and web apis
- 2. Designing RESTfull WebServices and Web APIs Best Practices Occasion: CodeCamp Iasi Date: 20-04-2013 Present: Remus Pereni / Software Architect / remus.pereni@tss-yonder.com Classification: Public
- 3. Remus Pereni Software Architect Yonder Romania TSS-Yonder http://tss-yonder.com @tssyonder Web & Mobile Web & Java Cluj Napoca Calea Dorobantilor 18-20 Power Twitter: @remuspereni Business Center Web: http://remus.pereni.org Iasi Sos. Pacurari 138 3
- 4. Evoluție API-‐uri De ce avem Bineinteles avem De ce avem Bineinteles ca nevoie de Web website! nevoie de API? avem un API! site? 1995 2000 2005 2013 4
- 5. Evoluție API-‐uri From Open APIs: State of the Market by John Musser, ProgrammableWeb 5
- 6. Evoluțe API-‐uri From Open APIs: State of the Market by John Musser, ProgrammableWeb 6
- 7. REST vs. SOAP: Simplicity wins again From Open APIs: State of the Market by John Musser, ProgrammableWeb Based on directory of 3,200 web APIs listed at ProgrammableWeb, May 2011 7
- 8. Componente 8
- 9. Resurse Web ● https://api.taskmgm.com/createCompany ● https://api.taskmgm.com/deleteCompany ● https://api.taskmgm.com/getCompany ● https://api.taskmgm.com/getAllCompanies ● https://api.taskmgm.com/getAllProjects ● https://api.taskmgm.com/getProject ● https://api.taskmgm.com/createProject ● https://api.taskmgm.com/updateProject ● https://api.taskmgm.com/deleteProject ● https://api.taskmgm.com/createLog ● https://api.taskmgm.com/updateLog ● https://api.taskmgm.com/deleteLog ● https://api.taskmgm.com/getLogs ● https://api.taskmgm.com/getLog 9
- 10. Resurse Web /{colecții} /{store-uri} conțin-> /{documente} care stocheză-> care au datele propriuzise 10
- 11. Resurse Web /companies /1234 - colectie - lista de companii - document - detalii companie 1234 11
- 12. Resurse Web ● https://api.taskmgm.com/v1/companies ● https://api.taskmgm.com/v1/companies/1234 ● https://api.taskmgm.com/v1/projects ● https://api.taskmgm.com/v1/projects/1234 ● https://api.taskmgm.com/v1/logs ● https://api.taskmgm.com/v1/logs/12182 12
- 13. Resurse Web /projects /favorites - colectie /1234 - lista de -un store proiecte -returneaza tot - document o listă - detalii proiect -cu proiectele favorit favorite 13
- 14. Resurse Web ● https://api.taskmgm.com/v1/projects ● https://api.taskmgm.com/v1/projects/1234 ● https://api.taskmgm.com/v1/projects/favorites ● https://api.taskmgm.com/v1/projects/favorites/1234 14
- 15. Resurse Web /{colecții} /{store-uri} conțin-> /{documente} care stocheză-> /{controlere} care au datele modeleaza propriuzise un concept procedural 15
- 16. Resurse Web /users /1234 - colectie /resetPassword - lista de - document utilizatori - detalii unui -controler anumit user reseteaza parola 16
- 17. Resurse Web ● https://api.taskmgm.com/v1/users ● https://api.taskmgm.com/v1/users/1234 ● https://api.taskmgm.com/v1/users/1234/resetPassword ● https://api.taskmgm.com/v1/users/login 17
- 18. Operații asupra resurselor / Metode HTTP Resursă POST GET PUT DELETE Crează Citește Actualizează Sterge /companies 201 Created 200 OK 405 Method 405 Method Crează o nouă Obtine lista de Not Allowed Not Allowed companie companii sau 200 OK sau 200 OK Actualizeaza Nimic sau toată lista de Sterge toata companii lista de companii /companies/ 405 Method 200 OK 200 OK 200 OK 1234 Not Allowed Obtine detalii Daca exista Sterge sau despre compania compania 404 Not compania 1234 1234 Found 1234 actualizeaza sau 404 Not altfel erroare: Found daca 404 Not nu există Found 18
- 19. URI, definiție ● RFC 3986 ● Syntaxa unui URI e: o scheme o "://" o authority o "/" path o [ "?" query ] o [ "#" fragment ] ● http://example.com/v1/users#name? q=Remus 19
- 20. URI / Best practice-uri ● Folositi substantive la plural si nu verbe o /companies o /users o /getUsers o /getCompanies ● Nu amestecati plural si singular, nu e consistent o /companies o /user o /users 20
- 21. URI / Best practice-uri Utilizati charactere mici in URI-uri (lowercase) ● https://api.taskmgm.com/v1/users o o resursa ● HTTP://Api.Taskmgm.com/v1/users o aceiasi resursa ca mai sus ● https://api.taskmgm.com/v1/Users o o alta resursa De ce? RFC 3896 defineste URI-urile case sensitive exceptind Protocol-ul si componentele host-ului scheme "://" authority "/" path [ "?" query ] [ "#" fragment ] 21
- 22. URI / Best practice-uri Nu includeti extensie de fisiere in URI-uri ● https://api.taskmgm.com/v1/users/1234.json Mecanismele HTTP pentru negocierea continutului Headerele o ACCEPT o ContentType 22
- 23. Formate multiple ● Implicit parte din HTTP ● header-ul: Accept Accept = "Accept" ":" #( media-‐range [ accept-‐params ] ) media-‐range = ( "*/*" | ( type "/" "*" ) | ( type "/" subtype ) ) *( ";" parameter ) accept-‐params = ";" "q" "=" qvalue *( accept-‐extension ) accept-‐extension = ";" token [ "=" ( token | quoted-‐string ) ] Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/ *; https://api.taskmgm.com/v1/companies?format=json 23
- 24. URI / Best practice-uri ● Forward slash separator (/) indica relatii hierarhice o http://example.org/vinzari/2012/08/01 24
- 25. URI / Best practice-uri ● Trailing forward slash (/) nu trebuie sa termine un URI o http://example.org/companies/1234/ o http://example.org/companies/1234 ● De ce? o Nu adauga valoare semantica o Poate cauza confuzie (2 uri-uri diferite trebuie sa identifice 2 resurse diferite) 25
- 26. URI / Best practice-uri Hypens (-) pot fi folosite pentru a imbunatatii readability-ul URI-urilor http://example.org/blogs/remus-pereni/entry/primul-post 26
- 27. URI / Best practice-uri Underscore (_) nu ar trebui folosite Link-urile de obicei sunt afisate cu underline si atuncea underscore poate fi confundat 27
- 28. Metode HTTP / GET ● Folosit pentru a obtine starea unei resurse ● Cererea poate contine headere dar nu body ● Cereri repetate la GET nu e voie sa aiba efecte secundare / duca la modificari de stare ● Cache-urile depind de abilitatea de a servi un raspuns fara a mai contacta serverul original 28
- 29. Metode HTTP / HEAD ● Exact ca si GET, returneaza doar headerele fara body ● Folosit la verifica existenta unei resurse sau a metadatelor legat de ea 29
- 30. Metode HTTP / PUT ● Folosit pentru insert si update-uri ● Mesajul trebuie sa contina o reprezentare a resursei pe care clientul doreste sa o stocheze pe server ● Continutul mesajului poate sa nu fie identic cu cea ce ar primi de la un request GET. Poate contine doar valorile mutabile / variabile din starea resursei ● Operatiune Idempotenta 30
- 31. Metode HTTP / POST ● Folosit pentru a crea o resursa noua intr-o colectie ● Folosit pentru a invoca controleri ● Permis pentru orice actiune fara legatura cu repetabilitatea sau efectele colaterale (unsafe & non-idempotent) ● Nu este garantata repetabilitatea ● A nu se folosi pentru a obtine / sterge / actualiza resurse 31
- 32. Metode HTTP / DELETE ● Folosita pentru a sterge o resursa dintr-o colectie ● O data stearsa cu DELETE resursa nu mai trebuie sa apartina colectiei (orice GET sau HEAD pe resursa respectiva trebuie sa se termine cu 404 NOT FOUND 32
- 33. Metode HTTP / OPTIONS ● Folosita pentru a sterge o obtine lista de operatii posibile asupra unei resurse ● Allow: GET, PUT, DELETE 33
- 34. Versionarea serviciilor ● Mai multe abordari o Versiune in path • http://example.com/timetrack/v1/companies/yonder o Versiune in header ● Versiune in header / parte din negocieri o Un URI trebuie sa identifice constant o resursa o Modificarea URI-ului presupune o resursa noua o Deci V1 & V2 denota 2 resurse diferite -> Incorect 34
- 35. Paginare ● Ascundeti complexitate in spate la ? o https://api.taskmgm.com/v1/companies?limit=10&offset=0 ● Puteti folosi limit și offset ● Să aveți valori implicite pentru ele 35
- 36. Cautare Fie prin controller https://api.taskmgm.com/v1/companies/search Ascundeti complexitate in spate la ? https://api.taskmgm.com/v1/companies?search=Yonder 36
- 37. Coduri de răspuns, tratarea exceptiilor Http status code : 401 Unauthorized ● { o “developerMessage” : “Verbose, plain language description of the problem for the app developer with hints about how to fix it.” o , “userMessage”:”Pass this message on to the app user if needed.” o , “errorCode” : 12345 o , “more info”: http://dev.teachdogrest.com/errors/12345 ● } 37
- 38. Coduri de răspuns, tratarea exceptiilor Totul a Success funcționat Erroare Aplicatia a facut ceva client greșit Erroare Ups s-a intinplat server ceva aiurea 38
- 39. Coduri de răspuns, tratarea exceptiilor ● HTTP Defineste 5 categorii 1XX Informational Comunica informatii la nivel de protocol 2XX Success Cererea clientului acceptata cu success 3XX Redirectari Indica ca sunt nevoie actiuni suplimentare pentru a complecta requestul 4XX Errori client Erroare datorata in general request-ului / Clientului 5XX Errori server Erroare datorata in general serverului 39
- 40. Coduri de răspuns, tratarea exceptiilor Success 200 OK Erroare 400 Bad client Reuest Erroare 500 Internal server Server Error 40
- 41. Coduri de răspuns, tratarea exceptiilor 41
- 42. Coduri de răspuns, tratarea exceptiilor Creare 201 Created Resursa 404 Not gresita Found Lipsa 401 autorizații Unauthorized Metoda 403 ne- Forbidden permisa 42
- 43. Coduri de răspuns, tratarea exceptiilor ● 200 (“OK”) o Codul pe care clientii spra sa-l vada o Indica success o In general trebuie sa includa un raspuns in body o Nu trebuie folosit in a comunica errori in continutul mesajului ● 201 (“Created”) o Folosit de cite ori o colectie sau un store creaza o resursa noua bazat pe cererea clientului o Poate fi si raspuns al apelului unui controller in cazul in care o resursa este creata ● 202 (“Accepted”) o Folosit pentru raspunsuri asincrone o O operatiune lunga a fost inceputa, pare valida dar poate inca genera errori o In general folosit la controlere 43
- 44. Coduri de răspuns, tratarea exceptiilor ● 204 (“No Content”) o Operatia e reusita dar nu exista continut de returnat (DELETE, de exemplu) ● 301 (“Moved Permanently”) o Resursa s-a mutat si exista o noua locatie pentru ea o Locatia se trimite ca parte a Location header-ului ● 303 (“See Other”) o Controler-ul si-a terminat treaba dar in loc sa trimita un raspuns potential nedorit poate trimite in Location un URI la o resursa care poate prezenta interes pentru clienti ● 304 (“Not Modified”) o Similar cu 204 (“No Content) in sensul ca body-ul e gol o Clientul are deja cea mai recenta versiune o Folosit impreuna cu alte headere ce determina HTTP Conditionale 44
- 45. Coduri de răspuns, tratarea exceptiilor ● 400 (“Bad Request”) o Mesaj de erroare generic cind nici un alt 4xx nu este potrivit o Raspunsul poate contine body cu mesaj detaliat legat de erroare ● 401 (“Unauthorized”) o Nu are authorizarea necesara sau nu a asigurat nici un fel de authorizare ● 403 (“Forbidden”) o Indica ca request-ul e corect dar backend-ul refuza sa-l onoreze o Nu este o problema de autorizare (ar fi 401), poate clientul nu are permisiunea de a apela acea parte din API ● 404 (“Not Found”) o Cererea nu poate fi mapata pe o resursa ● 405 (“Method Not Allowed”) o Daca clientul a incercat o operatie ne-permisa (ex: DELETE pe o resursa read only) o Trebuie sa se trimita inapoi header-ul Allow: GET, POST cu metodele suportate 45
- 46. Coduri de răspuns, tratarea exceptiilor ● 406 (“Not Acceptable”) o Formatul cerut de client nu este suportat (Ex. clientul cere application/xml prin intermediul headerului Accept dar serverul are pregatit doar application/json ● 409 (“Conflict”) o Daca se incearca punerea unei resurse intr-o stare inconsistenta o Ex, se incearca stergerea unei colectii care nu e goala ● 415 (“Unsuported Media Type”) o Indica ca serverul nu poate parsa cererea in formatul descris de header-ul Content-Type o Ex. Body-ul contine application/xml dar serverul stie sa trateze doar application/json ● 500 (“Internal Server Error”) o Probleme pe partea de server, ex exceptii aruncate si ne tratate 46
- 47. Resurse Web API Design? Crafting Interfaces that Developers Love By Brian Mulloy Ebook gratuit oferit de apigee http://apigee.com/about/ content/web-api-design 47
- 48. Resurse REST API Design Rulebook Designing Consistent RESTful Web Service Interfaces By Mark Masse Publisher: O'Reilly Media Released: October 2011 Pages: 116 48
- 49. Resurse 1. Atlassian REST API Design Guidelines version 1 https://developer.atlassian.com/display/DOCS/Atlassian+REST+API+Design+Guidelines+version+1 2. Thoughts on RESTful API Design Lessons learnt from designing the Red Hat Enterprise Virtualization API https://restful-api-design.readthedocs.org/en/latest/ 49
- 50. Întrebări? photo cc by http://www.flickr.com/photos/horiavarlan/4273168957/ 50
- 51. Thank You ! Please fill the evaluation form slide photo cc by http://www.flickr.com/photos/wwworks/4759535950/ 51