Swagger ne için kullanılır?

Swagger (şimdi OpenAPI Specification) RESTful API'leri tanımlamak, belgelemek ve görselleştirmek için kullanılır. Bu, geliştiricilerin, test uzmanlarının ve API tüketicilerinin hizmetin işlevselliğini kaynak koduna erişmeden anlamalarını sağlar.

Ana fonksiyonlar:

1. Belgeleme: API'nin etkileşimli otomatik dokümantasyonunu oluşturur.
2. Geliştirme: API geliştirmede yardımcı olur, net bir sözleşme tanımı sağlar.
3. Test: Swagger UI arayüzü, API uç noktalarını doğrudan tarayıcıdan test etmeye olanak tanır.
4. Kod üretimi: OpenAPI spesifikasyonuna dayanarak istemci kodu (SDK) veya sunucu stub'ları oluşturulabilir.
5. Tasarım: Kodlamaya başlamadan önce API tasarımı için araç olarak kullanılabilir (Design-First Yaklaşımı).

YAML formatında spesifikasyon fragmenti örneği:

# Kısa API açıklaması
openapi: 3.0.0
info:
  title: Test API'm
  version: 1.0.0
paths:
  /items:
    get:
      summary: Tüm öğelerin listesini al
      responses:
        '200':
          description: Öğeler listesi başarıyla 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 geliştirme ve kullanımında yer alan farklı taraflar arasında tutarlılığı sağlar.