Eylül 28, 2020

Swagger Nedir?

SWAGGER NEDİR?

Swagger’a geçmeden önce anlatmamın daha uygun olacağını düşündüğüm bir yapı var. Bu yapı API yapısı yani Application Programing Interface adından da anlaşılabileceği gibi bir uygulama arayüzüdür. Örneğin Python da bir bot yazacaksınız veyahut hazır olan API’ler üzerinden verileri veya bilgileri güncel olarak almak istediğiniz zaman API’ler devreye girer. Örneğin döviz çeviriciler, Film veritabanı gibi API ler bize hem güncellik hem de kolaylık sağlar. Kısacası internetten güncel, en son verileri çekmek istediğiniz zaman API’ler devreye girer.

API’ye kısaca biraz değinmişken, Swagger’ın ne olduğuna geçelim:

Swagger bir API türü olan REST API geliştirmek için bir sözleşme standartı ve bunu geliştirmek için bize yardımcı araçlar(tool) sağlar. Swagger’ın sunduğu uygulama standartı ve geliştirme ve dokümantasyon bize API geliştirme de hali hatrı sayılır bir kolaylık sağlar.

API’ler bir nevi insanların aynı dilde iletişim sağladığı gibi iki bilgisayarda aynı protokoller, aynı standartlar, iki bilgisayarın ve insanların anlaşabileceği uyum standartlarını içerir. Swagger çoğu dil ve uygulamayı desteklediği için API geliştirmede iyi bir platform olarak karşımıza çıkmaktadır. Swagger’ı diğer platformlardan ayıran en önemli noktası ise dokümantasyon ihtiyacını anlaşılır ve kolay kullanım açısından çok iyi bir şekilde sunabilmesi. Swagger bunları yaparken üç tane araç içerir:

1)Swagger Editor:OpenAPI özelliklerini yazabileceğiniz browser tabanlı bir editör

2)Swagger UI:OpenAPI özelliklerini bir kullanıcı arayüzüyle birlikte etkileşime hazır bir API belgesi olarak sunar.

3)Swagger Codegen: İki bilgisayarın birbiriyle haberleşebilmesi için gerekli client ve server kütüphanelerini oluşturur.

Swagger’ı kurabilmek için JSON ve YAML dillerini kullanılır. Bu iki dil, programda belgelerin, verilerin kısacası her şeyin depolandığı bir yerdir.

Swagger’ın Windows Üzerinde Kurulumu:

https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/installation.md 

Sitesinde belirtildiği gibi npm(Node Packaged Modules) yardımıyla swagger-ui yani kullanıcı arayüzünü bilgisayarımıza kurabiliyoruz. Aynı zamanda DockerHub yardımıyla da kurulum yapmamızda da imkan var. En son olarak ise github reposundan gerekli klasörlerin indirilip hosting sunucuya indirilmesi ile kurulumumuzu gerçekleştirebiliyoruz.

Swagger’ın Linux Üzerinde Kurulumu:

Swagger’ı linux üzerinde kullanabilmemiz için öncelikle npm paketini kurmamız gerekiyor.

Fedora için Nodejs kurulumu:

sudo dnf install nodejs

Ubuntu(Debian Tabanlı Dağıtımlar) için Nodejs kurulumu:

sudo apt install nodejs

Bunun sonrasında ise npm kurulumu gerekiyor:

sudo apt install npm

Bu kurulumlar yapıldıktan sonra swagger üzerinde nasıl ilerleyebileceğinizi bilmiyorsanız vereceğim adreste detaylı bir dokümantasyon sayfası var buna ulaşarak swagger-ui kullanmaya başlayabilirsiniz:

https://github.com/swagger-api/swagger-ui#documentation

Swagger’dan biraz bahsettikten sonra ve kurulumları yaptıktan sonra her programlama dilini öğrenmeye başladığınızda yaşadığınız gibi zorlu bir süreç sizleri bekliyor olacaktır. Bu süreci kolayca atlatabilmeniz için size birkaç link atacağım. Umarım işinize yarar, iyi kodlamalar :).

Youtube Playlist:

https://www.youtube.com/playlist?list=PLnBvgoOXZNCN0E_oNPrY1wfPhYIXpKbMS

https://www.youtube.com/watch?v=w-7OF3BOeTo&list=PLvrFFivBXOTZrxoZ86CtJAMHHZOo3HNYq&ab_channel=AngularJs

Siteler:

https://swagger.io/tools/open-source/getting-started/

https://idratherbewriting.com/learnapidoc/pubapis_swagger.html

Share

You may also like...

Bir Yorum Yazın