«api-design» etiketlenmiş sorular

Uygulama Programlama Arayüzü (API) Tasarımı, genel amaçlı veya genel kullanıma yönelik kütüphaneler oluşturmak için en iyi uygulamaları tartışır.

6
Çakışan işlev parametrelerini işlemek için bir kalıp var mı?
Verilen başlangıç ​​ve bitiş tarihlerine göre toplam tutarı aylık tutarlara ayıran bir API fonksiyonuna sahibiz. // JavaScript function convertToMonths(timePeriod) { // ... returns the given time period converted to months } function getPaymentBreakdown(total, startDate, endDate) { const numMonths = convertToMonths(endDate - startDate); return { numMonths, monthlyPayment: total / numMonths, }; …
38 api-design 

5
Kasıtlı olarak REST standartlarını ihlal eden bir mimari değişim nasıl tarif edilir?
Çok sayıda sorundan muzdarip, çok zayıf mimariye sahip bir yazılım projesinde değişiklikler öneriyorum. Yüksek düzeyde proje ön uçta Angular kullanır ve çeşitli REST API'leri kullanır; hangisi harika (teknolojimizi veya araçlarımızı değiştirme gereği duymuyorum). Sorun, kod tabanının UI'da sunucu tarafı API'lerden daha büyük olması. İş mantığının çoğu UI'de yaşar, REST API'leri …

3
REST API - API Yuvalanmış JSON Nesnelerini Döndürmeli mi?
JSON API'lerine gelince, yanıtları düzeltmek ve iç içe geçmiş JSON nesnelerinden kaçınmak iyi bir uygulama mıdır? Örnek olarak IMDb'ye benzer bir API'miz var ama video oyunları için. Oyun ve Platformları haritalayan bir kaç varlık, Oyun, Platform, ESRBRating ve GamePlatformMap vardır. Diyelim ki, ID 1 ile oyunu alan / oyun / …
37 design  rest  api-design  json 

6
Bir HTTP API her zaman bir gövde döndürmeli mi?
HTTP API yanıtlarıyla ilgili bir tür standart var mı? Bu konuyu okuduktan sonra merak etmeye başladım. Çalışmamda genel HTTP JSON API'mizi geliştiriyoruz ve kesinlikle gerekmediğinde hiçbir şey döndürmüyoruz (örneğin / PUT / resource / {id} 'a yalnızca OK veya karşılık gelen 4XX veya 5XX kodu girdiğinde 200 döndürür, ancak JSON …
33 rest  api-design  http 


4
Microservisler birbirleriyle konuşmalı mı?
Micro-Services kullanarak bir uygulama tasarlıyorum ve birden çok hizmetten veri toplamak için kullanılacak en iyi mekanizmadan emin değilim. İki seçenek olduğuna inanıyorum: Servislerin doğrudan konuşmasını sağlayan bir 'servisler arası' iletişim mekanizmasını entegre edin. API Ağ Geçidi, birleştirilmiş servisi API Ağ Geçidine vermeden önce, veri toplamak için diğer servisleri çağıran ayrı …


3
Yeni bir sistemde rezerve edilecek yaygın kullanıcı adlarının bir listesi var mı?
Bu soru edildi göç o Yazılım Mühendisliği Stack Exchange'de yanıtlanabilir çünkü yığın taşması gelen. 8 yıl önce göç etmiş . Yeni web sitemdeki kullanıcı adlarını ayırmam gerekiyor. Bunlar genellikle üç kategoriye ayrılır 1) hiç kimsenin sahip olmaması gereken kullanıcı adları (örneğin: admin, user, service, help, root, vb.) 2) ortaya çıkmaları …

4
Mikro servisler ve veri depolama
Monolitik bir REST API'sini bir mikro hizmet mimarisine taşımayı düşünüyorum ve veri depolama konusunda biraz kafam karıştı. Gördüğüm gibi, mikro hizmetlerin faydalarından bazıları şunlar olabilir: Yatay olarak ölçeklenebilir - Yük ve / veya aşağıya inen bir sunucu ile başa çıkmak için bir mikro hizmetin birden çok yedek kopyasını çalıştırabilirim. Gevşek …


3
HTML'i bir JSON API'sinden döndürmek uygun mudur?
Mevcut projemde yalnızca JSON'u desteklediği belgelenen yeni oluşturulan RESTful API'lerin tüketimini içeren bir hizmetin uygulanmasından sorumluyum. Müşteri sürekli 'application / json' kabul başlığını ve 'application / json' içerik türünü talep eder. Bununla birlikte, bazı bitiş noktaları bir HTML gövdesi bile olsa bir HTML içerik türüne bir yanıt gönderir. Bana göre …

10
API tasarımı: somut ve soyut yaklaşım - en iyi uygulamalar?
Sistemler arasındaki API'leri tartışırken (işletme düzeyinde) ekibimizde genellikle iki farklı bakış açısı vardır: bazı insanlar daha çok şey söyler - diyelim - genel soyut yaklaşım, bazıları ise doğrudan "somut" bir yaklaşım. Örnek: basit bir "kişi arama" API'sinin tasarımı. somut versiyon olurdu searchPerson(String name, boolean soundEx, String firstName, boolean soundEx, String …

4
Bir api oluştururken küçük işlevler ve birçok çağrı mı, birkaç çağrı ve büyük işlevler mi yapmalıyım?
Bakımını yaptığım ray platformum var. Bunun üzerine inşa edilmiş birçok farklı web uygulaması vardır. Ancak şimdi bir müşteri, kullanıcıları sitelerinde tutabilmeleri için bir API istiyor, ancak sahip olduğumuz bazı otomatik görevlerden yararlanabiliyor. Platform, sigorta uygulamaları oluşturmak için kullanılır ve çevrimiçi satın alınmalarına izin verir ve ayrıca poliçenizle ilgili belgeleri indirmek …

2
Kendi HTTP durum kodlarımı oluşturmalı mıyım? (bir Twitter 420: Sakin Olun)
Yazılım Mühendisliği Yığın Değişimi'nde yanıtlanabileceği için bu sorun Sunucu Arızasından geçirilmiştir . 6 yıl önce göç etmiş . Şu anda ilk defa bir HTTP API uyguluyorum. HTTP durum kodları için Wikipedia sayfasına bakarak çok zaman harcıyorum çünkü doğru durumlar için doğru kodları uygulamaya kararlıyım. Bu sayfada listelenen 420 numaralı bir …
24 api-design  http 

3
“Plan sınırı aşıldı” yanıtı için önerilen HTTP durum kodu
Kullanıcıların her zaman birkaç "plandan" birinde olduğu bir proje için bir REST API tasarlıyorum - her plan, bir hesabın sahip olabileceği maksimum kullanıcı sayısı veya yükleyebilecekleri maksimum veri sayısı gibi bazı kaynak sınırlarını tanımlar. Bu sınırlardan birine ulaşıldığında, kullanıcılar daha fazla kaynak elde etmek için planlarını yükseltebilir (temelde ödeme yaparlar). …
24 rest  api-design  http 

Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.