OpenAPI Spesifikasyonu, daha önce Swagger Spesifikasyonu olarak bilinen, RESTful web hizmetlerini tanımlamak, üretmek, tüketmek ve görselleştirmek için makine tarafından okunabilir arayüz dosyalarına yönelik bir spesifikasyondur. Daha önce Swagger çerçevesinin bir parçası olan bu spesifikasyon, 2016 yılında Linux Foundation'ın açık kaynaklı bir iş birliği projesi olan OpenAPI Initiative tarafından denetlenen ayrı bir proje haline geldi. Swagger ve diğer bazı araçlar, bir arayüz dosyası verildiğinde kod, belge ve test senaryoları üretebilir.
OpenAPI arayüz dosyalarına dayalı olarak uygulanan uygulamalar, metotların, parametrelerin ve modellerin belgelerini otomatik olarak üretebilir. Bu, belgelerin, istemci kitaplıklarının ve kaynak kodunun senkronize kalmasına yardımcı olur.
JSON Biçimindeki OpenAPI 3.0 Spesifikasyonunu okuyan ve otomatik olarak Native Pascal Kodunda bir Delphi İstemcisi oluşturan yeni bir OpenAPI WebService yayınlandı (şu anda BETA). WebService, API ile nasıl etkileşim kurulacağını gösteren bir demo oluşturur.
WebService, Spesifikasyonun 3.0+ ve JSON biçiminde olmasını gerektirir.
OpenAPI Spesifikasyonunu İçe Aktarma
İlk adım, openAPI 3.0 spesifikasyonunu içe aktarmaktır; bunu yapmak için bir IP Adresinin konumunu almak amacıyla abstractapi.com tarafından kullanılan basit bir openAPI spesifikasyonunu kullanacağım. Spesifikasyon dosyasını aşağıda bulabilirsiniz:
JSON biçiminde openAPI 3.0 spesifikasyonunu edindikten sonra, OpenAPI WebService'imizi kullanarak gerekli Delphi dosyalarını oluşturabilirsiniz; aşağıdaki URL'ye gidin:
https://www.esegece.com/products/openapi/ws/demo
Yalnızca sınıf adını (varsayılan olarak TsgcOpenAPI_Test olacaktır) ayarlayın ve spesifikasyon dosyasını yükleyin (önce sıkıştırmasını açın!!!, JSON biçiminde olmalıdır). Son olarak dosyayı işlemek için Upload düğmesine basın.
İşlem başarılı olursa, derlenmiş bir demo içeren yeni bir sıkıştırılmış dosya indirilecektir.
openAPI Demosunu Test Etme
Demoyu test etmeden önce, bir API Anahtarı almak için abstractapi.com'da ücretsiz bir hesap oluşturmanız gerekir.
https://app.abstractapi.com/users/signup
İndirilen dosyanın sıkıştırmasını açın ve Demo klasörüne gidin; bir sgcOpenAPIDemo.exe dosyası bulacaksınız, onu çalıştırın.
Abstractapi.com'un URL'sini gösteren yeni bir form görünür.
İleri düğmesine basın ve Retrieve_the_location_of_an_IP_address metodunu seçin; ardından aranacak Api_Key ve IP Adresini doldurun. İstek başarıyla işlenirse, IP Adresi hakkında bilgi içeren bir JSON mesajı döndürülür.
Testleri yapmak için sgcOpenAPI WebService tarafından otomatik olarak oluşturulan sıkıştırılmış dosyayı aşağıda bulabilirsiniz.