Swagger ve Araçları

Herkese merhaba, bu yaz stajında Swagger ile ilgili çalışmalar yapıyorum. Bu süreçte öğrendiğim konulardan bahsetmek istedim.

*Öncelikle  Open API Initiative'den bahsedecek olursam;
Linux Foundation altında açık denetimli bir yapı olarak oluşturulan, gelişmekte ve yükselişte olan bir tanımlama formatıdır. Swagger Specification doğrudan Open Specification'ın temeline dayanarak OAI'ye eklenmiştir.

*OpenAPI Specification(The Swagger Specification);

OpenAPI Specification'ın hedefi; insanların ve bilgisayarların anlayabilmesi için REST API'lerin arayüzlerine dilden bağımsız bir standard tanımlamaktır. OpenAPI var olan bir apiyi tekrar yazmamamızı sağlar ama OpenAPI Specification'ın yapısında tanımlanmış servislerin yeteneklerini belirlemek gerkir.

*Swagger nedir ve hangi amaçla kullanılır?

Swagger; REST Apilerin web ortamında kullanıcılara daha basit ve kullanışlı bir şekilde sunulmasını sağlar. Birçok dile frameworkü bulunmaktadır.
Bir diğer avantajı, herhangi bir dilde yazılmış bir REST Api'yi başka bir dile dönüştürmeye uygundur( Code Generation ).

Bu proje içinde kendi araçlarını barındırır. Bunları inceleyecek olursak;

*Swagger Core: Swagger'ın bir Java uygulamasıdır diyebiliriz. Github'ta uygulamalı olarak Java ile bir Swagger uygulaması bulunmaktadır.

*Swagger Codegen: Bir dilde yazılmış REST Api'leri istediğimiz dile dönüştürme işlemine yardımcı olur. Bunun java dili yardımıyla yapılışı Github'ta bulunmaktadır.

*Swagger UI: Swagger uyumlu hale getirilmiş Api'yi kullanıcıya sunan bir araçtır. Bu aracın da uyarlanışı Github'ta bulunmaktadır.

*Swagger Editor: Swagger tanımlamalarını YAML veya JSON formatta oluşturur. Sitesinde bulunan api'yi Generate Client bölümünden istediğimiz dile çevirebiliriz. Swagger Codegen'in yaptığı işlem buna karşılık geliyor. Bu uygulama konuyu anlamak için faydalı oldu benim için.
Uygulama linki  

*Swagger IRC

Peki her şeyi tasarladık adımları uyguladık kullanıcıların karşısına nasıl bir görüntü çıkacak;

Şekilde görüldüğü gibi uygulamadaki bir bölümle iligli işlemler kullanıcıya listelenmektedir. Kullanıcı istediği işlemi gerekli parametreleri girerek gerçekleştirebilir.

Bu yazımda Swagger'ın ne olduğundan, araçlarından, hangi kolaylıkları sağladığından bahsettim. Bir sonraki yazılarımda araçların nasıl kullanıldığından ve bir apinin Swagger uyumlu hale nasıl getirildiği hakkında yazacağım.
Görüşmek üzere.