Selam! Bir API (Aktif İlaç Malzemesi) Tedarikçisi olarak, API şemasının ne olduğu konusunda sık sık sorulur. Bu yüzden, sizin için anlaşılması kolay bir şekilde yıkmak için biraz zaman alacağımı düşündüm.
Temel bilgilerle başlayalım. API şeması bir API için bir plan gibidir. Bir API'nın nasıl çalıştığına, hangi verileri beklediğine ve hangi verilere döneceğine dair ayrıntılı bir açıklama. Bunu, hem API sağlayıcısının (bu benim!) Hem de API tüketicisinin (bu siz veya ekibiniz) düzgün ve verimli iletişim sağlamak için izlemesi gereken bir dizi kural ve yönerge olarak düşünün.
API şeması neden önemlidir?
Bir ev inşa ettiğinizi hayal edin. Sadece plan yapmadan tuğla atmaya başlamayacaksın, değil mi? Aynı şey API'ler için de geçerli. Bir API şeması, geliştiricilerin API'yı anlaması ve kullanması için net ve tutarlı bir yol sağlar. Yanlış anlamalardan kaçınmaya yardımcı olur, hata şansını azaltır ve API'yi farklı uygulamalara entegre etmeyi kolaylaştırır.
Örneğin, diyelim ki API'mizi bilgiye erişmek için kullanmak isteyen bir geliştirici sizsiniz.Nano-karbonlanmış niyobyum, mikron niyobyum karbür, ultra ince niyobyum karbür, hfc. API şeması, hangi uç noktaların kullanılabilir olduğunu, hangi parametreleri geçmeniz gerektiğini ve yanıtın hangi formatta olacağını söyleyecektir. Bu, API ile etkileşim kurmak ve ihtiyacınız olan verileri almak için kodu yazmanızı daha kolay hale getirir.
API şemasında ne var?
Bir API şeması tipik olarak aşağıdaki bileşenleri içerir:
1. Uç noktalar
Bunlar API'nın işlevselliğine erişmek için arayabileceğiniz URL'lerdir. Her uç nokta, bir ürün listesi almak, yeni bir sipariş oluşturmak veya kullanıcı bilgilerini güncellemek gibi belirli bir işlemi temsil eder.
2. Talep ve yanıt formatları
Şema, isteklerinize göndermeniz gereken verilerin biçimini (örneğin, JSON, XML) ve API'nın yanıtlarında iade edeceği verilerin biçimini tanımlayacaktır. Bu, veri işleme söz konusu olduğunda hem API sağlayıcısının hem de tüketicinin aynı sayfada olmasını sağlar.
3. Parametreler
Bunlar, işlemi özelleştirmek için bir uç noktaya aktarabileceğiniz değerlerdir. Örneğin, belirli bir ürün hakkında bilgi almak için bir ürün kimliği veya bir sipariş listesini filtrelemek için bir tarih aralığı geçebilirsiniz.
4. Hata işleme
Şema ayrıca API'nın hataları nasıl işleyeceğini açıklayacaktır. API'nın döndürebileceği hata kodlarını ve her kodun ne anlama geldiğini tanımlar. Bu, geliştiricilerin bir hata oluştuğunda neyin yanlış gittiğini ve nasıl düzeltileceğini anlamalarına yardımcı olur.
API şemaları türleri
Her biri kendi avantajları ve kullanım durumları olan çeşitli API şemaları vardır. En yaygın olanlardan bazıları şunlardır:
Openapi Spesifikasyonu (OAS)
Bu, dinlendirici API'leri belgelemek için en popüler standartlardan biridir. API'nın uç noktalarını, istek ve yanıt formatlarını, parametreleri ve daha fazlasını tanımlamak için bir YAML veya JSON dosyası kullanır. OAS, araçlar ve çerçeveler tarafından yaygın olarak desteklenir, bu da belgeler, SDK'lar ve test durumları oluşturmayı kolaylaştırır.
GraphQL şeması
GraphQL, müşterilerin tam olarak ihtiyaç duydukları verileri talep etmesini sağlayan API'ler için bir sorgu dilidir. Bir GraphQL şeması, API'nın döndürebileceği veri türlerini ve bu türlerde gerçekleştirilebilecek işlemleri tanımlar. Geleneksel dinlendirici API'lere kıyasla verilere erişmenin daha esnek ve verimli bir yolunu sağlar.
Protokol tamponları
Protokol tamponları (Protobuf), Google tarafından geliştirilen dil-agnostik ikili serileştirme formatıdır. Serileştirilecek ve süzülecek verilerin yapısını tanımlamak için bir şema dosyası kullanır. Protobuf, yüksek performans ve küçük mesaj boyutu ile bilinir, bu da API'ler için büyük miktarlarda veriyi ele alması gereken popüler bir seçimdir.
API şemalarını API tedarikçisi olarak nasıl kullanıyoruz
Bir API tedarikçisi olarak, API'lerimizin kullanımı ve entegre olmasını sağlamak için API şemalarına güveniyoruz. API'lerimizi belgelemek için OpenAPI spesifikasyonunu kullanıyoruz, bu da müşterilerimiz için net ve ayrıntılı belgeler sunmamızı sağlıyor. Bu belgeler, uç noktalar, istek ve yanıt formatları, parametreler ve hata işleme hakkında bilgi içerir.
Müşterilerimizden aldığımız istekleri doğrulamak için API şemalarını da kullanıyoruz. Gelen istekleri şemaya karşı kontrol ederek, verilerin doğru formatta olduğundan ve gerekli tüm parametrelerin mevcut olmasını sağlayabiliriz. Bu, hataları önlemeye yardımcı olur ve API'lerimizin güvenilir ve güvenli olmasını sağlar.
Ayrıca, SDK'lar ve test senaryoları oluşturmak için API şemalarını kullanıyoruz. OpenAPI spesifikasyonunu destekleyen araçlar kullanarak, farklı programlama dillerinde otomatik olarak kod oluşturabiliriz, bu da müşterilerimizin API'lerimizi uygulamalarına entegre etmesini kolaylaştırır. Ayrıca şemayı, API'lerimizin düzgün çalışmasını ve müşterilerimizin gereksinimlerini karşıladığından emin olmamıza yardımcı olan test vakaları oluşturmak için kullanıyoruz.
Gerçek dünya örnekleri
API şemalarının nasıl kullanıldığına dair bazı gerçek dünya örneklerine bir göz atalım.
Örnek 1: Hakkında bilgi almak için API'mizi kullanmaYüksek Kaliteli Tioksanten-9-One CAS: 492-22-8
Diyelim ki belirli bir kimyasal bileşik hakkında bilgi almak isteyen bir araştırmacınız. Bileşiğin özellikleri, sentez yöntemleri ve güvenlik bilgileri gibi verilere erişmek için API'mizi kullanabilirsiniz. API şeması size hangi uç noktayı arayacağınızı, hangi parametrelerin geçeceğini (örneğin CAS numarası) ve yanıtın hangi formatta olacağını söyleyecektir.
İşte Curl kullanarak API'mize bir istek örneği:
curl -x "https://api.oursite.com/compounds/492-22-8" -h "kabul: uygulama/json"Yanıt şu gibi görünebilir:
{"Name": "Tiooksanthen-9-on", "Cas_number": "492-22-8", "molecular_weight": 212.26, "özellikler": {"85-87 ° C", "85-87 ° C", "Boiling_Point": "Synthess [" 365.7 ° C "" 365.7 ° C'de ",", ",", ",", ",", ",", ",", ",", ",", ",", "," "," ",", "", "" 365.7 ° c X, z ... "," Yöntem 2: Aşağıdaki reaksiyon koşullarını kullanın ... "]}Örnek 2: için yeni bir sipariş oluşturmakCAS No.45943-61-0 Büyük Arz
Belirli bir API'nın büyük bir kaynağı için sipariş vermek isteyen bir ilaç şirketiyseniz, yeni bir sipariş oluşturmak için API'mizi kullanabilirsiniz. API şeması, bir sipariş oluşturmak için uç noktayı, istek biçimi (örn. Sipariş ayrıntıları, miktar ve teslimat adresi) ve yanıt biçimi (örn. Sipariş kimliği ve onay mesajı) tanımlar.
İşte Python'u kullanan API'mize bir istek örneği:
İçe Aktarma İstekleri url = "https://api.oursite.com/orders" data = {"ürün_id", "455943-61-0", "miktar": 1000, "dağıtım_address": "dağıtım_address": "123 Main St, anytown, usa"} headers =} yanıt = url ":" Uygulama/json "} request = url, url, başlıklar = başlıklar) print (prompe.json ())Yanıt şu gibi görünebilir:
{"Order_id": "123456", "Mesaj": "Sipariş başarıyla oluşturuldu. Siparişiniz 24 saat içinde işlenecektir." }Çözüm
Sonuç olarak, bir API şeması herhangi bir API'nın önemli bir parçasıdır. Geliştiricilerin API'yı anlaması ve kullanması, hata şansını azaltması ve API'yi farklı uygulamalara entegre etmeyi kolaylaştırması için net ve tutarlı bir yol sağlar. Bir API tedarikçisi olarak, API'lerimizin kullanımı kolay, güvenilir ve güvenli olduğundan emin olmak için API şemalarına güveniyoruz.
API'lerimizi ürünlerimizle ilgili bilgilere erişmek veya sipariş vermek için kullanmak istiyorsanız, sizden haber almak isteriz. İster araştırmacı, ister bir ilaç şirketi veya bir geliştirici olun, API'lerimiz size ihtiyacınız olan verileri ve işlevselliği sağlayabilir. Bu nedenle, gereksinimlerinizi tartışmak ve tedarik sürecini başlatmak için bize ulaşmaktan çekinmeyin. API'lerimizden en iyi şekilde yararlanmanıza ve bizimle olan deneyiminizin olumlu olmasını sağlamak için buradayız.
Referanslar
- Fielding, RT (2000). Mimari stiller ve ağ tabanlı yazılım mimarilerinin tasarımı. California Üniversitesi, Irvine.
- Khare, R. ve Frystyk, H. (1997). Köprü Aktarım Protokolü - HTTP/1.1. RFC 2068.
- Lindley, S. ve Miller, B. (2015). GraphQL: Bir veri sorgu dili. Facebook.
- Varda, A. (2008). Protokol arabellekleri: Google'ın veri değişim biçimi. Google Açık Kaynak Blog.
