Csak a referencia vegett:
Ajanlott eloadas: Hadi Hariri — Embracing HTTP in the era of REST API's
Gyakran hasznalatos HTTP metodusok:
- OPTIONS: Rendelkezesre allo metodusok, illetve tovabbi vegpontok lekerdezese az adott vegpontra. (Discoverability)
- GET: Eroforras lekerese (vagy listazasa). Pl: GET /blogposts v. GET /blogposts/1
- POST: Uj eroforras letrehozasa, pl: POST /blogposts
- PUT: Eroforras felulirasa, pl: PUT /blogposts/1
- PATCH: Eroforras reszleges modositasa, pl: PATCH /blogposts/1
- DELETE: Eroforras torlese, pl: DELETE /blogposts/1
Gyakran hasznalatos 4xx statusz kodok:
- 400: A kliens hulyeseget kuldott. Lasd meg: RFC7231
- 401: Ilyet kuldhet vissza az API, de kuldenie kell melle egy WWW-Authenticate fejlecet is. Ez a WWW-Authenticate hivatott megmondani a kliensnek hogy hogyan kell autentikalnia. Tovabbi infok: WWW-Authenticate @ MDN RFC7235
- 403: A kert eroforras az adott jogosultsagi szinttel nem elerheto vagy egyaltalan nem elerheto. Lasd meg: RFC7231
- 404: Az adott eroforras nem talalhato. Lasd meg: RFC7231
- 405: GET helyett POST-ot kuldott a kliens, stb. Lasd meg: RFC7231
- 406: A kliens az Accept fejlecben olyan adattipust vagy egyeb kovetelmenyt kert, ami nem all rendelkezesre. (pl. YAML-t kert, de Te csak JSON-t tamogatsz.) Lasd meg: RFC7231
- 409: Konfliktus, pl. az adott eroforras mar letezik (unique key para) Lasd meg: RFC7231
- 410: Az eroforras valaha letezett, de most mar nem letezik. Lasd meg: RFC7231
- 415: A kliens altal kuldott adattipus nem tamogatott, pl YAML-t kuldott de a szerver csak JSON-t tamogat. Lasd meg: RFC7231
Gyakran hasznalt fejlecek:
- Authorization: usernev/jelszo vagy API kulcs kuldesere alkalmas.
- WWW-Authenticate: autentikacios utasitas 401-es statusz kod eseten
- Content-Type: a keres vagy valasz adattipus a es potencialisan kodolasa
- Content-Encoding: tomorites tipusa (pl. gzip). Tobbnyire a webszerver megoldja, nem kell vele foglalkozni
- Accept: csak keresekben, megmondja a szervernek hogy milyen adatformatumban szeretne az adatot.
- Accept-Encoding: a Content-Encodinghoz megmondja a szervernek hogy milyen tomoritessel keri az adatot.
- Accept-Language: megmondja a szervernek hogy milyen nyelven kuldje az adatot
- Accept-Charset: megmondja a szervernek hogy milyen karakterkodolassal kuldje a valaszt.
Egyebkent nem kell mindenkinek REST API-t csinalnia, az amit az eloado leirt az egy sima RPC-jellegu API. Az is teljesen jol hasznalhato ha jol van megtervezve, csak nevezzuk neven a gyereket. (Az eloado leirt habitusabol gyanitom hogy itt a jol megtervezes nem all fent.)