Swagger nə üçün istifadə olunur?

Swagger (indiki OpenAPI Specification) RESTful API-ləri təsvir etmək, sənədləşdirmək və vizuallaşdırmaq üçün istifadə olunur. Bu, inkişaf etdiricilərə, testçilərə və API istifadəçilərinə xidmətin funksionallığını mənbə koduna daxil olmadan başa düşməyə imkan verir.

Əsas funksiyalar:

1. Sənədləşdirmə: API üçün avtomatik interaktiv sənədləşdirmə yaradılması.
2. İnkişaf: API-nin inkişafında kömək edir, aydın müqavilə təyin edir.
3. Test: Swagger UI interfeysi API-nin son nöqtələrini brauzerdən birbaşa test etməyə imkan verir.
4. Kod nəsil: OpenAPI spesifikasiyasına əsaslanaraq müştəri kodu (SDK) və ya server stub-larını yarada bilərsiniz.
5. Dizayn: Kodlamadan əvvəl API dizaynı üçün vasitə kimi istifadə oluna bilər (Design-First Yanaşması).

YAML formatında spesifikasiya fragmentinin nümunəsi:

# API haqqında qısa təsvir
openapi: 3.0.0
info:
  title: Mənim test API
  version: 1.0.0
paths:
  /items:
    get:
      summary: Bütün elementlərin siyahısını əldə et
      responses:
        '200':
          description: Elementlərin siyahısı uğurla alındı
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Item'
components:
  schemas:
    Item:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string

Bu, API-nin inkişafı və istifadəsində iştirak edən müxtəlif tərəflər arasında uyğunluğu təmin edir.