Swagger API, yazılım geliştiricilerin RESTful web hizmetlerini tasarlamasına, oluşturmasına, belgelemesine ve kullanmasına yardımcı olan geniş bir araç ekosistemi tarafından desteklenen açık kaynaklı bir yazılım framework’udur.
Çoğu kullanıcı Swagger’ı, Swagger UI aracıyla tanımlasa da Swagger araç seti otomatik dokümantasyon, kod oluşturma ve test senaryosu oluşturma desteği içerir. SmartBear Software tarafından desteklenen Swagger, açık kaynaklı yazılımların güçlü bir destekçisi olmuştur ve yaygın bir şekilde kullanılır.
Swagger’ın açık kaynaklı takım kullanımı farklı kullanım durumlarına ayrılabilir. Bunlar geliştirme, API’lerle etkileşim ve ya dokümantasyon olabilir.
Swagger araçları şunları içerir:
Swagger Editor – OpenAPI özelliklerini yazabileceğiniz browser tabanlı editör sunar.
Swagger UI – OpenAPI özelliklerini etkileşimli API belgesi olarak sunar.
Swagger Codegen – bir OpenAPI’dan sunucu taslakları ve istemci kütüphaneleri oluşturur.
API Geliştirme
API oluştururken Swagger aracı, kodun kendisine göre otomatik olarak bir Açık API belgesi oluşturmak için kullanılabilir. Bu, API açıklamasını bir projenin kaynak koduna gömer. Böylece otomatik bir şekilde API oluşmaya başlar.
Alternatif olarak, Swagger Codegen kullanarak geliştiriciler kaynak kodunu Open API belgesinden ayırabilir ve doğrudan tasarımdan istemci ve sunucu kodu oluşturabilir.
API’larla etkileşim kurma
Swagger Codegen projesini kullanarak, son kullanıcılar istemci SDK’larını doğrudan OpenAPI belgesinden oluşturur ve kişiler tarafından oluşturulan istemci koduna olan ihtiyacı azaltır. Ağustos 2017 itibariyle, Swagger Codegen projesi, istemci SDK üretimi için 50’den fazla farklı dil ve formatı destekledi.
Dokümantasyon API’ları
Bir OpenAPI belgesi tarafından tanımlandığında Swagger API, Swagger kullanıcı arayüzü üzerinden doğrudan API ile etkileşim kurmak için kullanılabilir. Bu proje, etkileşimli HTML tabanlı bir kullanıcı arabirimi aracılığıyla doğrudan canlı API’lerle bağlantı kurulmasını sağlar. İstekler doğrudan kullanıcı arayüzünden ve arayüzün kullanıcısı tarafından keşfedilen seçeneklerden yapılabilir.
