TypeScript ve OpenAPI Codegen ile Sözleşme Testleri
Merhaba! Ben Fatih Soysal ve bugün sizlerle API geliştirme sürecinde büyük önem taşıyan sözleşme testlerini TypeScript ve OpenAPI Codegen kullanarak nasıl uygulayabileceğimizden bahsedeceğim. Bu yaklaşım, API sağlayıcısı ve tüketicisi arasında tutarsızlıkları erken aşamada tespit ederek, entegrasyon sorunlarını önlememize yardımcı olur.
Öncelikle, sözleşme testinin ne olduğunu kısaca açıklayalım. Sözleşme testi, API’nin belirli bir girdi için belirli bir çıktıyı üretmesini doğrulayan bir test türüdür. Bu testler, API’nin spesifikasyonuna (genellikle OpenAPI/Swagger tanımlamasıyla belirtilir) bağlı kalarak çalışır ve bu sayede, API’nin sözleşmeye uygun şekilde çalıştığından emin oluruz. Bu, hem API sağlayıcısı hem de tüketicisi için büyük bir güvence sağlar.
OpenAPI Codegen, OpenAPI spesifikasyonundan çeşitli programlama dillerinde istemci ve sunucu kodları üreten güçlü bir araçtır. Biz bu makalede, TypeScript için OpenAPI Codegen’i kullanarak sözleşme testlerimizi oluşturacağız. Bu sayede, API spesifikasyonumuzdaki değişiklikleri takip ederek, testlerimizi otomatik olarak güncelleyebilir ve tutarlılığımızı koruyabiliriz.
Adım Adım Uygulama
Şimdi, basit bir örnek üzerinden adım adım nasıl ilerleyeceğimizi görelim. Öncelikle, bir OpenAPI spesifikasyon dosyamız (genellikle openapi.yaml veya openapi.json) olmalı. Bu dosya, API’nin uç noktalarını, parametrelerini ve yanıtlarını tanımlar. Ardından, OpenAPI Codegen’i kullanarak TypeScript istemci kodunu oluşturuyoruz.
openapi-generator-cli generate -i openapi.yaml -g typescript-axios -o client
Bu komut, openapi.yaml dosyasından TypeScript istemci kodunu client dizinine oluşturur. Sonrasında, bu istemci kodunu kullanarak sözleşme testlerimizi yazabiliriz. Örneğin, Jest gibi bir test çerçevesi kullanarak aşağıdaki gibi bir test yazabiliriz:
import { ApiClient, YourApi } from './client';
describe('Contract Tests', () => {
const api = new YourApi(new ApiClient());
it('should return a 200 status code', async () => {
const response = await api.yourEndpoint({param1: 'value1'});
expect(response.status).toBe(200);
});
});
Bu örnekte, yourEndpoint fonksiyonu API’nin bir uç noktasını çağırıyor ve yanıtın durum kodunun 200 olduğunu doğrulayan bir test yazdık. Benzer şekilde, yanıtın içeriğini de doğrulayabilirsiniz. Örneğin, belirli alanların belirli değerlere sahip olduğunu kontrol edebilirsiniz. Daha karmaşık senaryolar için, mock veri kullanabilir veya farklı durum kodlarını ve yanıtları test edebilirsiniz.
Faydaları ve İpuçları
Sözleşme testleri, API geliştirme sürecinde birçok fayda sağlar. Bunlardan bazıları şunlardır:
- Erken hata tespiti
- API sağlayıcısı ve tüketicisi arasında daha iyi iletişim
- Otomatik testler sayesinde daha hızlı ve güvenilir geliştirme
- API’nin tutarlılığının korunması
Sözleşme testleri yazarken bazı ipuçlarına dikkat etmek faydalı olacaktır. Örneğin, testlerinizi küçük ve odaklı tutun. Her bir test, API’nin belirli bir özelliğini doğrulamalıdır. Ayrıca, test verilerinizi dikkatlice seçin ve mümkün olduğunca gerçekçi veriler kullanın. Son olarak, testlerinizi düzenli olarak çalıştırmayı ve API’nizde yapılan değişikliklere göre güncellemeyi unutmayın.
Daha fazla bilgi ve örnek için buraya bakabilirsiniz. Kendi geliştirme blogum için de burayı ziyaret edebilirsiniz.
Umarım bu makale size yardımcı olmuştur. Herhangi bir sorunuz varsa lütfen yorumlarda belirtin!
#Etiketler: Sözleşme Testi, Contract Test, TypeScript, OpenAPI, OpenAPI Codegen, API Testi, API Geliştirme, Yazılım Testi, API Sözleşmesi, Otomatik Test, Jest