İçindekiler:
Yazılım geliştirmenin doğasıdır. Geliştiriciler, son kullanıcı düşünülerek yazılım oluşturur. Bu oldukça basit görünüyor, ancak bazen bu kullanıcılar aynı zamanda diğer geliştiricilerdir. Onlar için parçalanmış şeylere ihtiyaçları yok. Basitliğe bile ihtiyaç duymazlar. Tek istedikleri erişim - yazılımınızı kendileriyle entegre etmenin bir yolu. Burası bir API (uygulama programlama arayüzü) devreye giriyor. Başarılı bir API oluşturmak için atabileceğiniz beş adımı vurgulamayı umuyorum.
Ödevini yap
Yazılım geliştirme söz konusu olduğunda, hiçbirimiz tekerleği yeniden icat etmek istemiyoruz. Bu noktada, neredeyse tüm büyük Web şirketlerinin yazılım ürünleri için API'leri vardır. Bu API'ları inceleyin ve bunları oluşturmaya yönelik farklı tasarım kararlarını almaya çalışın.
Orada birçok farklı teknoloji var, ancak göreceğiniz API'lerin çoğu RESTful arayüzü veya SOAP kullanacak. Hangi API arayüzünü kullanacağınız konusunda kararsızsanız, HTTP protokolünü kullanarak RESTful bir yaklaşımla gitmenizi öneririm. SOAP'tan daha basit, şu anda daha popüler ve Web tabanlı bir yazılım ürünü kullanırken başlamak daha kolay olacak.
Tutarlı olun
Geliştiricilerin en çok takdir ettiği şeylerden biri tutarlılıktır. Bu, diğer şeylerin yanı sıra adreslenebilirlik, girdi bağımsız değişkenleri, çıktı biçimleri ve hata işlemeyi içerir.
RESTful yaklaşımını kullanırken, birçok farklı URI adlandırma şeması vardır. Her birinin destekçileri var, bu yüzden sadece birini seçin ve ona sadık kalın. Aynı şey giriş ve çıkış yapısı için de geçerlidir. Çoğu API, giriş ve çıkış formatları olarak XML ve JSON kullanımını destekler. Her ikisini de desteklemeyi öneririm, ancak varsayılan bir biçim seçerim.
Giriş için, giriş gereksinimleriniz tutarlı bir şekilde adlandırılmalı ve yaptığınız API çağrısı bağlamında anlamlı olmalıdır. Çıktı için, ortak veri yapısı düzenleri kullandığınızdan emin olun. Bir API çağrısının çıktısını bir
İstemciye geri gönderdiğiniz çıktı verilerine bir tür durum bayrağı eklemek yaygın bir uygulamadır. RESTful API yaklaşımı kullanılırken, bu HTTP durum kodları kullanılarak yapılmalıdır. Örneğin, varolan bir veri nesnesi üzerinde yeni bir PUT isteği işlediyseniz, yanıtınıza eklediğiniz HTTP durum kodu, isteğin sonucuna bağlı olarak değişir.
Çağrının durumunu gösteren rastgele bir işaret yerine, isteğin başarılı olduğunu belirtmek için standart bir "200 OK" durum kodu kullanılabilirken, isteğin gerçekleştiğini belirtmek için "400 Hatalı İstek" durum kodu kullanılabilir şekil bozukluğuna. Farklı durumlarda kullanılabilecek oldukça az sayıda HTTP durum kodu vardır.
OAuth Kullan
Çoğu yazılım ürünü, o kullanıcı için korunan kaynaklara erişmek amacıyla bir tür kullanıcı kimlik doğrulaması içerir. API'lar söz konusu olduğunda, istemcinin sunucunuza göndermek için kullanıcı kimlik bilgilerini toplamasını sağlamak kötü bir uygulamadır. İşte bu noktada OAuth devreye giriyor.
OAuth, üçüncü taraf kullanıcı adı / şifre kimlik doğrulamasına göre birçok avantaj sağlar. Her şeyden önce, müşteri hiçbir zaman kullanıcının kimlik bilgilerine erişemez. Kullanıcı oturum açtığında sunucunuza yönlendirilir. Kullanıcı sitenize giriş yaptıktan sonra, istemciye, korunan kaynaklara gelecekteki isteklerde kullanmak üzere bir erişim belirteci gönderileceği istemciye yeniden yönlendirilir.
OAuth kullanmanın bir diğer önemli yararı, kullanıcının istediği zaman istemci erişimini iptal etme yeteneğidir. Kullanıcı, hangi nedenle olursa olsun, artık istemcinin kendi adına korunan kaynaklara erişmesini istemediğine karar verirse, yalnızca oluşturduğunuz bir arabirime gider ve istemcinin erişimini iptal eder.
Erken başla
API'nızı başarılı kılmak için yapabileceğiniz en önemli şeylerden biri erken başlamaktır. Veritabanınızda bir girdi oluşturmak için bu işlevi yazdığınızda, devam edin ve fazladan zaman ayırın ve bunun için bir API arayüzü yazın.İyi Belgeler Yazın
Hiçbir şey API'yi iyi belgelere sahip olmamaktan daha hızlı öldüremez. Bazı geliştiriciler kötü belgelenmiş bir API alabilir ve nasıl çalışması gerektiğini anlasa da çoğu istemez.
Kullanabileceğiniz her API çağrısını belgelemeli ve API çağrılarınızı, üzerinde çalıştıkları veri türüne göre kategorilere ayırmalısınız. API çağrılarının kendileri için uç noktaları belgelemenin yanı sıra, gerekli ve isteğe bağlı girdi bağımsız değişkenlerini ve çıktı veri yapılarını sistematik olarak tanımlamanız gerekir. Girdi bağımsız değişkenleri, varsa varsayılan bir değer listelemeli ve ayrıca sayı veya dize gibi beklenen veri biçimini göstermelidir. Son olarak, her API çağrısında hata durumlarının ve durum kodlarının bir listesi bulunmalıdır.
Belgelerinizi tamamlamak için, her API çağrısı için ortak giriş ve çıkış senaryolarına bir veya iki örnek eklediğinizden emin olun.
API Geliştirme: Basit Olsun
Bir API geliştirmenin karmaşık bir çaba olduğu görünse de, bir API'nin kendisi fikri yeni bir kavram değildir ve burada ele aldığımız her konuda büyük miktarda mevcut dokümantasyon vardır. Bunları bulabileceğiniz iyi uygulamaları kullandığınızdan ve tutarlı, iyi belgelenmiş bir arayüz sağladığınızdan emin olun.
