SQL API nedir?

Bu yazı ÇiçekSepeti teknoloji ekibinin geliştirdiği SQL API’nin ne olduğunu ve nasıl kullanıldığını anlatmaktadır.

You can access the English version via this link.

SQL API nedir?

• Database’e sorgu atmamızı sağlayan HTTP isteğidir. Projenin kaynak koduna buradan ulaşabilirsiniz: SQL API.

SQL API hangi sorunu çözmektedir?

• Başarılı HTTP isteklerini gönderdikten sonra veritabanında bulunan kayıtları kontrol eder.
  Örneğin: POST isteklerinde database’e atılan dataların kaydedildiğini, DELETE isteklerinde database’den dataların silindiğini kontrol eder.

SQL API hangi database’leri destekler?

• MySQL
• MsSQL
• MongoDB

SQL API nasıl kullanılır?

• Database’i oluşturduktan sonra test edilecek tool üzerinden(Postman, RestAssured, Insomnia) SQL API isteği oluşturulur. HTTP isteği local test koşumları için http://localhost:8033/sql url’ine çıkarak yapılabilir. Bu isteğin body’sinde database ve query bilgilerini içermelidir.

Farklı database’lerde SQL API request body kullanımları:

MongoDB için request body

MySql için request body

MsSql için request body

Postman’de oluşturulmuş SQL API örneği:

Bu örnekte Pre-request’te POST isteğiyle kullanıcı oluşturulmaktadır. Fakat isteğin response’unda kullanıcı bilgileri gelmemektedir. Aynı test senaryosunda SQL API’ye istek atarak database’deki kayıdı oluşturulan kullanıcı dataları kontrol edilmektedir.

Pre-request’te başarılı bir customer oluşturulur.

Body’de SQL API için database configleri ve query hazırlanır.

Test adımında databasedeki querynin kontrolü yapılır.

Faydalı linkler:

https://hub.docker.com/r/techciceksepeti/sqlapi
https://github.com/ciceksepetitech/sqlapi