2. SWAGGER NEDİR ?
SWAGGER progamlama dillerinden ve projede
çalışan kişilerden bağımsız olarak back end ile
ön yüz arasında köprü görevi gören ve API
iletişimi sağlayan kendi ekosistemi ve tolları
olan olan büyük bir platformdur.
3. SWAGGER EKOSİSTEM NEDİR
Swagger Editor
Tarayıcı içinde gerçek zamanlı olarak API’yi düzenleyip ön izlemesini
yapmamıza olanak sağlar.
Swagger Codegen
Client side kütüphanelerinin ve sunucu şablonlarının oluşturulmasına
olanak sağlar.
Swagger UI
Herhangi bir bağımlılığı olmayan sade ve kolay bir arayüz sunar.
5. SWAGGER ÖZELLİKLERİ
API'nın Swagger gösterimi tek bir dosya swagger.json'dan yapılır. (Fakat diğer
kaynaklara başvurabilir)
Genel olarak JSON kullanılır ancak YAML da kullanılabilir.
Tüm alan adları büyük küçük harfe duyarlıdır.
Swagger’daki eski veri türleri JSON’a çevrilmektedir.
Modeller Şema kullanılarak açıklanmıştır.
6. SWAGGER OBJECTS
EXTERNAL DOCS
Harici dökümanlar
DEFİNİTİONS
Operasyonel olarak üretilen ve
kullanılan veri türleri
PATHS
kullanılabir operasyonel
tanımlar
PARAMETERS
İşlemler arasında kullanılabilen
parametreler
RESPONSES
İşlemler arasında
kullanılabilecek yanıtlar
SECURITY
Kullanılabilecek alternatif
güvenlik planları
SECURITY DEFINITIONS
Güvenlik şeması tanımları
TAGS
Ek metadata’ları içeren tags
listesi
12. KULLANIM ÖZELLİKLERİ
Veritabanımıza erişebilecek DEMO API'sini tasarlamak istiyoruz.
Veritabanımızda her öğe için 2 temel data objesi var olmalı : Article ve Author
API'mizden gelen tüm yanıtlar JSON olmalıdır.
Bu şekilde yapabiliriz
. Tüm makaleleri çekmek için
GET /v1/article
. Tüm yazarların belirli bir konu hakkındaki makaleleri için
GET /v1/article/{id}/authors
