Asosiy kontentga o'tish

Web · API dizayni

REST API qanday ishlaydi?

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.

  • Qiyinlik: O'rta
  • 35 daqiqa
  • 18 mavzu
  • 5 savolli test
Sizning progressingiz
0%
jonli jarayonKalit bilan so'rov
  1. Mobil ilova POST /payments Har bir to'lov uchun noyob UUID kalit yaratadi.
  2. Tarmoq mobil internet Ishonchsiz kanal: javob yo'lda yo'qolishi mumkin.
  3. API PaymentController So'rovni bajarishdan oldin kalitni tekshiradi.
  4. Kalitlar ombori Redis · 24 soat Kalit va unga tegishli saqlangan javob.
  5. Database payments To'lov yozuvlari.
Kurs rejasi 0%
  1. REST API nima?
  2. Qanday ishlaydi
  3. Arxitektura
  4. Komponentlar
  5. Vizual misollar
  6. Simulyatsiya
  7. Kod va oqim
  8. Mavzular
  9. Xato va amaliyot
  10. Mini test

01 Kirish

REST API nima?

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).

Turi
Arxitektura uslubi
Transport
HTTP / HTTPS
Odatiy format
JSON
Asosiy birlik
Resurs + URI
Holat
Stateless

02 Qanday ishlaydi

POST /api/v1/orders: buyurtma yaratish

Pastga aylantiring: mobil ilova yangi buyurtma yuboradi, so'rov rate limit, token, validatsiya va database'dan o'tib, 201 Created bo'lib qaytadi.

  1. Mobil ilova

    So'rov yuboriladi

    Ilova POST /api/v1/orders ga {"product_id": 12, "qty": 2} body'sini, Content-Type: application/json va Bearer token bilan yuboradi.

  2. Rate limiter

    Limit tekshiriladi

    Bu foydalanuvchi oxirgi daqiqada 14 ta so'rov yuborgan, limit 60. So'rov o'tadi, javobga X-RateLimit-Remaining qo'shiladi.

  3. Token tekshiruvi

    Kim yuborgani aniqlanadi

    Token hash'i personal_access_tokens jadvalidan topiladi. Server sessiyaga emas, har bir so'rovdagi token'ga tayanadi (Stateless).

  4. Router

    Marshrut topiladi

    apiResource yaratgan orders.store marshruti tanlanadi. URI'dagi v1 — API versiyasi.

  5. Validatsiya

    Body tekshiriladi

    product_id mavjudmi, qty musbat butun sonmi? Hammasi to'g'ri. Xato bo'lsa, so'rov shu yerda 422 bilan qaytarilardi.

  6. Controller

    Buyurtma yaratiladi

    Controller faqat tekshirilgan maydonlarni oladi va buyurtmani joriy foydalanuvchiga bog'lab yaratadi.

  7. Database

    Database'ga yoziladi

    INSERT bajariladi, yangi buyurtma id = 381 oladi.

  8. API Resource javob

    JSON tayyorlanadi

    API Resource model'ni {"data": {"id": 381, "status": "pending", ...}} ko'rinishiga keltiradi. Ichki ustunlar tashqariga chiqmaydi.

  9. Response javob

    201 Created

    Yangi resurs yaratilgani uchun 200 emas, 201. Location: /api/v1/orders/381 header'i yangi resurs manzilini ko'rsatadi.

  10. Mobil ilova javob

    Ilova natijani ko'rsatadi

    Ilova data.id ni saqlaydi va buyurtma sahifasini ochadi. Keyingi so'rov GET /api/v1/orders/381 bo'ladi.

03 Arxitektura

REST API tuzilishi

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.

  • Resurslar · URI /orders/{id}
  • Method'lar GET POST PATCH DELETE
  • JSON format data, meta, errors
  • Status kodlar 2xx 4xx 5xx

Himoya kirish nazorati

So'rov logikaga yetishidan oldingi tekshiruvlar.

  • Autentifikatsiya Bearer token
  • Rate limiting 429
  • Validatsiya 422

Implementatsiya ichki qism

Client ko'rmaydigan, erkin o'zgarishi mumkin bo'lgan qism.

  • Controller OrderController
  • Resource OrderResource
  • Database orders

04 Asosiy qismlar

Asosiy tushunchalar

  • Resurs

    API boshqaradigan narsa: foydalanuvchi, buyurtma, mahsulot. Ot bilan, ko'plikda nomlanadi: /orders.

  • URI

    Resursning manzili. /orders — to'plam, /orders/381 — bitta element.

  • HTTP method

    Resurs ustidagi amal. Fe'l URI'da emas, method'da: DELETE /orders/381, POST /deleteOrder emas.

  • Status kodi

    Natija turi: 200, 201, 204, 400, 401, 403, 404, 422, 429, 500.

  • JSON

    Ma'lumot almashish formati. Bir xil tuzilma (data, meta, errors) client ishini osonlashtiradi.

  • Token

    So'rovni kim yuborganini bildiradi. Authorization: Bearer <token> header'ida keladi.

  • Rate limit

    Vaqt birligidagi so'rovlar chegarasi. Serverni haddan tashqari yuklanish va suiiste'moldan saqlaydi.

  • Versiya

    /api/v1 — eski client'larni buzmasdan API'ni o'zgartirish imkoni.

05 Vizual misollar

Ko'rib tushunamiz

Har bir tushuncha o'z diagrammasi bilan: ustiga olib boring, bosing va jarayonni kuzating.

Taqqoslash

Method'lar va CRUD

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
Jadvallar va bog'lanish

Jadvallardan URI'larga

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 : 1

Qator ustiga olib boring: bog'langan qatorlar yonadi.

Ketma-ketlik

Token, rate limit va xatolar

Bitta client'ning bir necha so'rovi: login, muvaffaqiyatli so'rov, ruxsatsiz so'rov va limitdan oshish.

  1. Client dan APIga: POST /api/v1/tokens Email va parol bilan token so'raladi.
  2. API dan Databasega: token hash saqlash Server tasodifiy token yaratadi va uning hash'ini saqlaydi.
  3. API dan Clientga: 201 {token} Ochiq token faqat bir marta ko'rsatiladi.
  4. Client dan APIga: GET /orders + Bearer Har bir so'rov token'ni header'da olib keladi.
  5. API dan Clientga: 200 {data, meta} Ro'yxat va pagination ma'lumoti.
  6. Client dan APIga: GET /orders/380 Boshqa foydalanuvchining buyurtmasi so'raldi.
  7. API dan Clientga: 403 / 404 Ruxsat yo'q. Ba'zi API'lar resurs borligini yashirish uchun 404 qaytaradi.
  8. Client dan APIga: 61-so'rov / daqiqa Limit oshib ketdi.
  9. API dan Clientga: 429 + Retry-After Client qancha kutish kerakligini header'dan biladi.
9 ta xabar
Terminal

curl bilan API'ni sinash

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

Idempotency-Key: takroriy so'rov xavfsiz

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.

0 / 10
  1. Mobil ilova POST /payments Har bir to'lov uchun noyob UUID kalit yaratadi.
  2. Tarmoq mobil internet Ishonchsiz kanal: javob yo'lda yo'qolishi mumkin.
  3. API PaymentController So'rovni bajarishdan oldin kalitni tekshiradi.
  4. Kalitlar ombori Redis · 24 soat Kalit va unga tegishli saqlangan javob.
  5. Database payments To'lov yozuvlari.
Tayyor

«Qayta urinish» tugmasini bosing

Yoki istalgan tugunni tanlang: uning vazifasi shu yerda ochiladi.

  • Mijoz
  • Tarmoq
  • Logika
  • Kesh
  • Ma'lumot
  • so'rov
  • javob

07 Kod va oqim

Laravel'da REST API

Bitta apiResource qatori beshta marshrut yaratadi. Chapda kod, o'ngda so'rov qaysi qatlamda turgani.

routes/api.php · OrderController.phpphp
// 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));}
  1. /api/v1 prefix Versiyalangan URI.
  2. Middleware sanctum · throttle Token va rate limit tekshiruvi.
  3. apiResource 5 ta marshrut index, store, show, update, destroy.
  4. Form Request StoreOrderRequest Body validatsiyasi.
  5. Eloquent orders Database bilan ishlash.
  6. OrderResource JSON Javob formati.

08 Mavzular

REST API mavzulari

18 ta mavzu, har biri qisqa izoh va kichik diagramma bilan. Ochgan mavzuingiz progressga qo'shiladi.

Asoslar 10

REST nima? Client → HTTP + JSON → API

HTTP ustida API qurish uslubi: resurslar, URI'lar, standart method'lar va stateless so'rovlar. Bu protokol emas, qoidalar to'plami.

Resurslar va URI /orders → /orders/381

URI ot bo'ladi, fe'l emas, ko'plikda: /orders, /orders/381. Amal method orqali aytiladi.

GET /api/v1/orders/381
Method'lar va CRUD GET → POST → PATCH → DELETE

CRUD amallari method'larga mos keladi: GET o'qish, POST yaratish, PUT to'liq almashtirish, PATCH qisman o'zgartirish, DELETE o'chirish.

Status kodlar So'rov → Natija → Status kodi

201 yaratildi, 204 body'siz muvaffaqiyat, 401 token yo'q, 403 ruxsat yo'q, 404 topilmadi, 422 validatsiya xatosi.

JSON javob tuzilmasi data → meta → links

Bir xil qolip: asosiy ma'lumot data ichida, pagination meta va links da. Client har doim nimani kutishini biladi.

{"data": {"id": 381, "status": "pending"}}
Stateless So'rov + token → Server A yoki B → Javob

Server so'rovlar orasida sessiya saqlamaydi, har bir so'rov token olib keladi. Shuning uchun istalgan server nusxasi istalgan so'rovni bajara oladi.

Ichma-ich resurslar /users/1 → /orders

Bog'liqlik URI'da ko'rinadi: /users/1/orders. Bir darajadan chuqur ichma-ichlikdan qoching.

GET /api/v1/users/1/orders
Filtr va saralash /orders → ?status=paid → &sort=-created_at

Ro'yxatni toraytirish query parametrlar bilan qilinadi, yangi URI bilan emas.

GET /api/v1/orders?status=paid&sort=-created_at
Pagination ?page=1 → ?page=2 → next: null

Pagination: minglab yozuvni bir javobda bermang. Sahifa raqami (?page=2) yoki cursor (?cursor=eyJpZCI6...) bilan bo'lib bering.

Order::latest()->cursorPaginate(20);
Xato formati Xato → 422 → {message, errors}

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": ["..."]}}

Chuqurroq 8

Versiyalash /api/v1 → /api/v2

Mavjud client'larni buzadigan o'zgarish (maydonni o'chirish, nomini o'zgartirish) yangi versiyada qilinadi: /api/v2. Yangi maydon qo'shish buzmaydi.

Idempotency So'rov → Kalit bormi? → Saqlangan javob

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
Token autentifikatsiya Login → Token → Bearer header

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;
Rate limiting So'rov → Hisoblagich → 429 / OK

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(...);
Keshlash ETag → If-None-Match → 304

GET javoblariga ETag va Cache-Control qo'shing. Client If-None-Match yuborsa, o'zgarmagan ma'lumot uchun 304 qaytadi.

API Resource'lar Model → Resource → JSON

Model va JSON orasidagi qatlam. Database ustunlari o'zgarsa ham API shartnomasi barqaror qoladi, maxfiy maydonlar chiqmaydi.

return new OrderResource($order);
Hujjatlash openapi.yaml → Swagger UI → Client SDK

OpenAPI spetsifikatsiyasi har bir endpoint, parametr va javobni mashina o'qiy oladigan formatda tasvirlaydi. Undan interaktiv hujjat va client kodi yaratiladi.

CORS SPA → OPTIONS → API

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

Xatolardan qoching, to'g'risini qiling

Keng tarqalgan xatolar

  • URI'da fe'llar

    /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.

  • Har doim 200

    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.

  • Model'ni to'g'ridan-to'g'ri qaytarish

    return User::all() yangi ustun qo'shilganda uni (masalan, ichki bayroqlarni) avtomatik tashqariga chiqaradi.

    API Resource bilan faqat ommaviy maydonlarni aniq belgilang.

  • Pagination yo'q

    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.

  • Faqat ID bo'yicha ruxsat

    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.

Eng yaxshi amaliyotlar

  1. Izchil nomlash

    Barcha URI ko'plikda, kichik harflarda, so'zlar - bilan. JSON maydonlari bir uslubda (masalan, snake_case).

  2. Boshidan versiya

    Birinchi kundan /api/v1. Keyin buzuvchi o'zgarish kerak bo'lganda client'lar uchun o'tish davri bo'ladi.

  3. Bir xil xato formati

    Har qanday xato message va kerak bo'lsa errors bilan qaytsin. Client bitta xato ishlovchisi bilan ishlaydi.

  4. Rate limit va token muddati

    Har bir endpoint'ga limit, token'larga muddat va minimal huquqlar (abilities) bering.

  5. Feature testlar

    Har bir endpoint uchun status kodi va JSON tuzilmasini test qiling: assertCreated(), assertJsonPath('data.id', ...).

10 Mini test

O'zingizni sinab ko'ring

5 ta savol. Javobni tanlang: darhol to'g'ri yoki noto'g'ri ekanini va sababini ko'rasiz.

1/5Yangi buyurtma muvaffaqiyatli yaratilganda qaysi status kodi eng to'g'ri?
2/5Qaysi method idempotent emas?
3/5Validatsiyadan o'tmagan body uchun Laravel API odatda qaysi kodni qaytaradi?
4/5Ilova to'lov so'rovini yubordi, lekin javob kelmadi. Qayta yuborishni xavfsiz qilish uchun nima kerak?
5/5REST API'ning stateless bo'lishi nimani anglatadi?

Atamalar lug'ati

Resurs
API orqali boshqariladigan obyekt yoki to'plam: foydalanuvchi, buyurtma, mahsulot.
Stateless
Server so'rovlar orasida client holatini saqlamaydi, har bir so'rov mustaqil.
Bearer token
Authorization: Bearer <token> header'ida yuboriladigan kirish kaliti. Egasi kim bo'lsa, o'sha kirish huquqiga ega.
API Resource
Laravel'da model'ni JSON javob formatiga aylantiradigan klass.
Idempotency
Amalni bir necha marta bajarish bir marta bajarish bilan bir xil natija berishi.
Pagination
Katta ro'yxatni sahifalarga bo'lib qaytarish.
Rate limiting
Ma'lum vaqt ichidagi so'rovlar sonini cheklash.
OpenAPI
REST API'ni mashina o'qiy oladigan formatda (YAML yoki JSON) tasvirlash standarti.
CRUD
Create, Read, Update, Delete — ma'lumot ustidagi to'rt asosiy amal.

Keyingi qadam: bog'liq texnologiyalar