HTTP
Browser va server qanday gaplashadi: DNS, TCP, TLS, request, response va kesh vizual ko'rinishda.
Web · API dizayni
Mobil ilova buyurtma yaratganda so'rov qaysi tekshiruvlardan o'tib, qanday JSON javob bo'lib qaytishini ko'ring. So'ng tarmoq uzilganda takroriy so'rov qanday xavfsiz bo'lishini sinab ko'ring.
POST /payments Har bir to'lov uchun noyob UUID kalit yaratadi.
mobil internet Ishonchsiz kanal: javob yo'lda yo'qolishi mumkin.
PaymentController So'rovni bajarishdan oldin kalitni tekshiradi.
Redis · 24 soat Kalit va unga tegishli saqlangan javob.
payments To'lov yozuvlari.
01 Kirish
API — dasturlar bir-biri bilan gaplashadigan shartnoma. REST esa HTTP ustida API qurish uslubi: hamma narsa Resurs sifatida qaraladi va har bir resursning o'z URI manzili bor.
Resurs ustidagi amal HTTP method bilan aytiladi: GET /orders ro'yxatni oladi, POST /orders yangisini yaratadi, DELETE /orders/7 o'chiradi. Natija status kodi va odatda JSON body bilan qaytadi.
REST API Stateless: server so'rovlar orasida client holatini saqlamaydi. Har bir so'rov o'zini tanitish uchun token olib keladi, shuning uchun serverlarni gorizontal ko'paytirish oson.
Hayotiy o'xshatish
REST API'ni kutubxona katalogiga o'xshating: har bir kitobning aniq raqami (URI) bor, siz esa bir xil cheklangan amallarni bajarasiz — olish, qo'shish, almashtirish, chiqarib tashlash (GET, POST, PUT, DELETE).
02 Qanday ishlaydi
Pastga aylantiring: mobil ilova yangi buyurtma yuboradi, so'rov rate limit, token, validatsiya va database'dan o'tib, 201 Created bo'lib qaytadi.
Ilova POST /api/v1/orders ga {"product_id": 12, "qty": 2} body'sini, Content-Type: application/json va Bearer token bilan yuboradi.
Bu foydalanuvchi oxirgi daqiqada 14 ta so'rov yuborgan, limit 60. So'rov o'tadi, javobga X-RateLimit-Remaining qo'shiladi.
Token hash'i personal_access_tokens jadvalidan topiladi. Server sessiyaga emas, har bir so'rovdagi token'ga tayanadi (Stateless).
apiResource yaratgan orders.store marshruti tanlanadi. URI'dagi v1 — API versiyasi.
product_id mavjudmi, qty musbat butun sonmi? Hammasi to'g'ri. Xato bo'lsa, so'rov shu yerda 422 bilan qaytarilardi.
Controller faqat tekshirilgan maydonlarni oladi va buyurtmani joriy foydalanuvchiga bog'lab yaratadi.
INSERT bajariladi, yangi buyurtma id = 381 oladi.
API Resource model'ni {"data": {"id": 381, "status": "pending", ...}} ko'rinishiga keltiradi. Ichki ustunlar tashqariga chiqmaydi.
Yangi resurs yaratilgani uchun 200 emas, 201. Location: /api/v1/orders/381 header'i yangi resurs manzilini ko'rsatadi.
Ilova data.id ni saqlaydi va buyurtma sahifasini ochadi. Keyingi so'rov GET /api/v1/orders/381 bo'ladi.
03 Arxitektura
Yaxshi API uch qatlamdan iborat: tashqi shartnoma (URI va format), himoya qatlami va ichki implementatsiya.
REST API /api/v1
Client'lar uchun ochiq shartnoma.
Shartnoma client nimani ko'radi
Hujjatlashtirilgan va barqaror qism.
/orders/{id} GET POST PATCH DELETE data, meta, errors 2xx 4xx 5xx Himoya kirish nazorati
So'rov logikaga yetishidan oldingi tekshiruvlar.
Bearer token 429 422 Implementatsiya ichki qism
Client ko'rmaydigan, erkin o'zgarishi mumkin bo'lgan qism.
OrderController OrderResource orders 04 Asosiy qismlar
API boshqaradigan narsa: foydalanuvchi, buyurtma, mahsulot. Ot bilan, ko'plikda nomlanadi: /orders.
Resursning manzili. /orders — to'plam, /orders/381 — bitta element.
Resurs ustidagi amal. Fe'l URI'da emas, method'da: DELETE /orders/381, POST /deleteOrder emas.
Natija turi: 200, 201, 204, 400, 401, 403, 404, 422, 429, 500.
Ma'lumot almashish formati. Bir xil tuzilma (data, meta, errors) client ishini osonlashtiradi.
So'rovni kim yuborganini bildiradi. Authorization: Bearer <token> header'ida keladi.
Vaqt birligidagi so'rovlar chegarasi. Serverni haddan tashqari yuklanish va suiiste'moldan saqlaydi.
/api/v1 — eski client'larni buzmasdan API'ni o'zgartirish imkoni.
05 Vizual misollar
Har bir tushuncha o'z diagrammasi bilan: ustiga olib boring, bosing va jarayonni kuzating.
Har bir method'ning ma'nosi va xususiyatlari bor. Safe — ma'lumotni o'zgartirmaydi, idempotent — necha marta takrorlansa ham natija bir xil.
| GET | POST | PUT | PATCH | DELETE | |
|---|---|---|---|---|---|
| CRUD | Read | Create | Update (to'liq) | Update (qisman) | Delete |
| Misol | GET /orders/381 | POST /orders | PUT /orders/381 | PATCH /orders/381 | DELETE /orders/381 |
| Body | Yo'q | Yangi resurs | Butun resurs | Faqat o'zgargan maydonlar | Odatda yo'q |
| Safe | Ha | Yo'q | Yo'q | Yo'q | Yo'q |
| Idempotent | Ha | Yo'q | Ha | Kafolatlanmagan | Ha |
| Muvaffaqiyat | 200 | 201 + Location | 200 yoki 204 | 200 | 204 |
Bog'langan jadvallar ichma-ich URI bo'lib ko'rinadi: GET /users/1/orders — 1-foydalanuvchining buyurtmalari, ya'ni orders.user_id = 1.
users
| id PK BIGINT | name VARCHAR | email VARCHAR |
|---|---|---|
| 1 | Ali | ali@example.uz |
| 2 | Malika | malika@example.uz |
orders
| id PK BIGINT | user_id FK BIGINT | status VARCHAR | total INT |
|---|---|---|---|
| 380 | 2 | paid | 120000 |
| 381 | 1 | pending | 50000 |
| 382 | 1 | paid | 75000 |
orders.user_id ustuni ishora qiladi: users.id N : 1Qator ustiga olib boring: bog'langan qatorlar yonadi.
Bitta client'ning bir necha so'rovi: login, muvaffaqiyatli so'rov, ruxsatsiz so'rov va limitdan oshish.
POST /api/v1/tokens
Email va parol bilan token so'raladi. token hash saqlash
Server tasodifiy token yaratadi va uning hash'ini saqlaydi. 201 {token}
Ochiq token faqat bir marta ko'rsatiladi. GET /orders + Bearer
Har bir so'rov token'ni header'da olib keladi. 200 {data, meta}
Ro'yxat va pagination ma'lumoti. GET /orders/380
Boshqa foydalanuvchining buyurtmasi so'raldi. 403 / 404
Ruxsat yo'q. Ba'zi API'lar resurs borligini yashirish uchun 404 qaytaradi. 61-so'rov / daqiqa
Limit oshib ketdi. 429 + Retry-After
Client qancha kutish kerakligini header'dan biladi. Ro'yxat, yaratish, validatsiya xatosi va o'chirish: har birining status kodi va javob tuzilmasiga e'tibor bering.
curl -s https://example.uz/api/v1/orders?page=2 -H "Authorization: Bearer $TOKEN"
{"data":[{"id":381,"status":"pending","total":50000}],
"links":{"next":null,"prev":"https://example.uz/api/v1/orders?page=1"},
"meta":{"current_page":2,"per_page":20,"total":21}}
curl -i -X POST https://example.uz/api/v1/orders -H "Authorization: Bearer $TOKEN" -H 'Content-Type: application/json' -d '{"product_id":12,"qty":2}'
HTTP/2 201
content-type: application/json
{"data":{"id":383,"status":"pending","total":90000}}
curl -s -X POST https://example.uz/api/v1/orders -H "Authorization: Bearer $TOKEN" -H 'Accept: application/json' -d 'qty=-1'
{"message":"The product id field is required. (and 1 more error)",
"errors":{"product_id":["The product id field is required."],
"qty":["The qty field must be at least 1."]}}
curl -i -X DELETE https://example.uz/api/v1/orders/383 -H "Authorization: Bearer $TOKEN"
HTTP/2 204
06 Interaktiv simulyatsiya
Run tugmasini bosing: to'lov so'rovi bajarildi, lekin javob tarmoqda yo'qoldi. Ilova qayta yuboradi, server esa kalit bo'yicha ikkinchi to'lovni yaratmaydi. «Qayta urinish» tugmasini bosing yoki bosqichma-bosqich yuring. Istalgan tugun ustiga boring yoki bosing: uning vazifasi ochiladi.
POST /payments Har bir to'lov uchun noyob UUID kalit yaratadi.
mobil internet Ishonchsiz kanal: javob yo'lda yo'qolishi mumkin.
PaymentController So'rovni bajarishdan oldin kalitni tekshiradi.
Redis · 24 soat Kalit va unga tegishli saqlangan javob.
payments To'lov yozuvlari.
«Qayta urinish» tugmasini bosing
Yoki istalgan tugunni tanlang: uning vazifasi shu yerda ochiladi.
Tanlangan tugun
07 Kod va oqim
Bitta apiResource qatori beshta marshrut yaratadi. Chapda kod, o'ngda so'rov qaysi qatlamda turgani.
// routes/api.phpRoute::prefix('v1')->middleware(['auth:sanctum', 'throttle:60,1'])->group(function () { Route::apiResource('orders', OrderController::class);}); // app/Http/Controllers/Api/OrderController.phppublic function index(Request $request){ return OrderResource::collection( $request->user()->orders()->latest()->paginate(20) );} public function store(StoreOrderRequest $request){ $order = $request->user()->orders()->create($request->validated()); return (new OrderResource($order)) ->response() ->setStatusCode(201) ->header('Location', route('orders.show', $order));}
prefix Versiyalangan URI.
sanctum · throttle Token va rate limit tekshiruvi.
5 ta marshrut index, store, show, update, destroy.
StoreOrderRequest Body validatsiyasi.
orders Database bilan ishlash.
JSON Javob formati.
08 Mavzular
18 ta mavzu, har biri qisqa izoh va kichik diagramma bilan. Ochgan mavzuingiz progressga qo'shiladi.
HTTP ustida API qurish uslubi: resurslar, URI'lar, standart method'lar va stateless so'rovlar. Bu protokol emas, qoidalar to'plami.
URI ot bo'ladi, fe'l emas, ko'plikda: /orders, /orders/381. Amal method orqali aytiladi.
GET /api/v1/orders/381 CRUD amallari method'larga mos keladi: GET o'qish, POST yaratish, PUT to'liq almashtirish, PATCH qisman o'zgartirish, DELETE o'chirish.
201 yaratildi, 204 body'siz muvaffaqiyat, 401 token yo'q, 403 ruxsat yo'q, 404 topilmadi, 422 validatsiya xatosi.
Bir xil qolip: asosiy ma'lumot data ichida, pagination meta va links da. Client har doim nimani kutishini biladi.
{"data": {"id": 381, "status": "pending"}} Server so'rovlar orasida sessiya saqlamaydi, har bir so'rov token olib keladi. Shuning uchun istalgan server nusxasi istalgan so'rovni bajara oladi.
Bog'liqlik URI'da ko'rinadi: /users/1/orders. Bir darajadan chuqur ichma-ichlikdan qoching.
GET /api/v1/users/1/orders Ro'yxatni toraytirish query parametrlar bilan qilinadi, yangi URI bilan emas.
GET /api/v1/orders?status=paid&sort=-created_at Pagination: minglab yozuvni bir javobda bermang. Sahifa raqami (?page=2) yoki cursor (?cursor=eyJpZCI6...) bilan bo'lib bering.
Order::latest()->cursorPaginate(20); Xatolar ham bir xil tuzilmada: inson uchun message, dastur uchun maydonlar bo'yicha errors. RFC 9457 (Problem Details) standart format taklif qiladi.
{"message": "...", "errors": {"qty": ["..."]}} Mavjud client'larni buzadigan o'zgarish (maydonni o'chirish, nomini o'zgartirish) yangi versiyada qilinadi: /api/v2. Yangi maydon qo'shish buzmaydi.
GET, PUT, DELETE ni takrorlash xavfsiz. POST uchun Idempotency-Key header'i bilan server takroriy so'rovni taniydi.
Idempotency-Key: 9f1c6b2e-4d7a-4f0e-9a51-2c8d3e7b1a90 Client token'ni Authorization: Bearer header'ida yuboradi. Server uning hash'ini saqlaydi, token o'g'irlansa uni bekor qilish mumkin.
$token = $user->createToken('mobile', ['orders:read'])->plainTextToken; Client yoki IP bo'yicha so'rovlar soni cheklanadi. Limit oshsa 429 Too Many Requests va Retry-After header'i qaytadi.
Route::middleware('throttle:60,1')->group(...); GET javoblariga ETag va Cache-Control qo'shing. Client If-None-Match yuborsa, o'zgarmagan ma'lumot uchun 304 qaytadi.
Model va JSON orasidagi qatlam. Database ustunlari o'zgarsa ham API shartnomasi barqaror qoladi, maxfiy maydonlar chiqmaydi.
return new OrderResource($order); OpenAPI spetsifikatsiyasi har bir endpoint, parametr va javobni mashina o'qiy oladigan formatda tasvirlaydi. Undan interaktiv hujjat va client kodi yaratiladi.
Browser'dagi SPA boshqa domendagi API'ga so'rov yuborsa, API Access-Control-Allow-Origin bilan ruxsat berishi kerak. Mobil ilova va server uchun CORS ahamiyatsiz.
09 Amaliyot
/getOrders, /createOrder, /deleteOrder?id=5 — method'lar ma'nosiz bo'lib qoladi va API tartibsiz o'sadi.
Ot va method: GET /orders, POST /orders, DELETE /orders/5.
Xato bo'lsa ham 200 va {"success": false} qaytarilsa, client, kesh va monitoring xatoni ko'rmaydi.
Natijaga mos status kodi: 201, 204, 401, 403, 404, 422, 429, 500.
return User::all() yangi ustun qo'shilganda uni (masalan, ichki bayroqlarni) avtomatik tashqariga chiqaradi.
API Resource bilan faqat ommaviy maydonlarni aniq belgilang.
GET /orders 100 000 qatorni qaytaradi: javob sekin, xotira to'ladi, mobil trafik isrof bo'ladi.
Har bir ro'yxatni paginate() yoki cursorPaginate() bilan bo'ling va maksimal per_page belgilang.
GET /orders/380 token egasiga tegishli emasligini tekshirmaslik boshqalarning ma'lumotini ochadi (IDOR).
Resursni joriy foydalanuvchi orqali oling ($user->orders()->findOrFail($id)) yoki Policy bilan tekshiring.
Barcha URI ko'plikda, kichik harflarda, so'zlar - bilan. JSON maydonlari bir uslubda (masalan, snake_case).
Birinchi kundan /api/v1. Keyin buzuvchi o'zgarish kerak bo'lganda client'lar uchun o'tish davri bo'ladi.
Har qanday xato message va kerak bo'lsa errors bilan qaytsin. Client bitta xato ishlovchisi bilan ishlaydi.
Har bir endpoint'ga limit, token'larga muddat va minimal huquqlar (abilities) bering.
Har bir endpoint uchun status kodi va JSON tuzilmasini test qiling: assertCreated(), assertJsonPath('data.id', ...).
10 Mini test
5 ta savol. Javobni tanlang: darhol to'g'ri yoki noto'g'ri ekanini va sababini ko'rasiz.
Authorization: Bearer <token> header'ida yuboriladigan kirish kaliti. Egasi kim bo'lsa, o'sha kirish huquqiga ega.