Inżynieria oprogramowania api-design

6

Czy istnieje wzorzec obsługi sprzecznych parametrów funkcji?

Mamy funkcję API, która dzieli całkowitą kwotę na kwoty miesięczne na podstawie danych dat rozpoczęcia i zakończenia. // 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 / …

38 api-design

3

Interfejs API REST - czy interfejs API powinien zwracać zagnieżdżone obiekty JSON?

Jeśli chodzi o interfejsy API JSON, czy dobrą praktyką jest spłaszczanie odpowiedzi i unikanie zagnieżdżonych obiektów JSON? Jako przykład powiedzmy, że mamy interfejs API podobny do IMDb, ale do gier wideo. Istnieje kilka encji: Gra, Platforma, ESRBRating i GamePlatformMap, która mapuje Gry i platformy. Powiedzmy, że żądasz / game / …

38 design rest api-design json

5

Jak opisać zmianę architektoniczną, która celowo łamie standardy REST?

Proponuję zmiany w bardzo źle zaprojektowanym projekcie oprogramowania, który ma wiele problemów. Na wysokim poziomie projekt wykorzystuje Angular na interfejsie i zużywa różne interfejsy API REST; co jest świetne (nie widzę potrzeby zmiany naszej technologii ani narzędzi). Problem polega na tym, że podstawa kodu jest nieproporcjonalnie większa w interfejsie użytkownika …

37 rest api-design enterprise-architecture

6

Czy interfejs API HTTP powinien zawsze zwracać treść?

Czy istnieje jakiś standard dotyczący odpowiedzi API HTTP? Po przeczytaniu tego wątku dyskursu zacząłem się zastanawiać. W mojej pracy opracowujemy nasz publiczny interfejs HTTP JSON API i nie zwracamy niczego, gdy nie jest to absolutnie potrzebne (na przykład PUT do / resource / {id} zwraca tylko 200, gdy OK lub …

33 rest api-design http

10

Dlaczego Math.Sqrt () jest funkcją statyczną?

W dyskusji na temat metod statycznych i metod instancji zawsze myślę, że Sqrt()powinna to być metoda instancji typów liczb zamiast metody statycznej. Dlaczego? Oczywiście działa na wartość. // looks wrong to me var y = Math.Sqrt(x); // looks better to me var y = x.Sqrt(); Typy wartości oczywiście mogą mieć …

31 programming-languages language-design history api-design math

4

Czy Microservices powinny ze sobą rozmawiać?

Projektuję aplikację przy użyciu Mikro-usług i nie jestem pewien, jaki jest najlepszy mechanizm gromadzenia danych z wielu usług. Wierzę, że są dwie opcje: Zintegruj mechanizm komunikacji „między usługami”, który umożliwia usługom bezpośrednią rozmowę. Interfejs API Gateway wywoływałby pojedynczą usługę, która następnie wywołuje inne usługi w celu gromadzenia danych, zanim zwróci …

30 architecture api-design microservices

7

Po co używać nieprzezroczystego „uchwytu”, który wymaga rzutowania na publiczny interfejs API zamiast na bezpieczny wskaźnik struktury?

Oceniam bibliotekę, której publiczny interfejs API wygląda obecnie tak: libengine.h /* Handle, used for all APIs */ typedef size_t enh; /* Create new engine instance; result returned in handle */ int en_open(int mode, enh *handle); /* Start an engine */ int en_start(enh handle); /* Add a new hook to the …

27 c api-design libraries

3

Czy istnieje lista popularnych nazw użytkowników do zarezerwowania w nowym systemie?

To pytanie zostało przeniesione z przepełnienia stosu, ponieważ można na nie odpowiedzieć w programie Software Engineering Stack Exchange. Migrował 8 lat temu . Muszę zarezerwować nazwy użytkowników w mojej nowej witrynie. Zasadniczo można je podzielić na trzy kategorie 1) nazwy użytkowników, których nikt nie powinien mieć (np .: administrator, użytkownik, …

26 database design data api-design

4

Mikrousługi i przechowywanie danych

Zastanawiam się nad przeniesieniem monolitycznego interfejsu API REST na architekturę mikrousług i mam trochę wątpliwości co do przechowywania danych. Moim zdaniem niektóre z zalet mikrousług byłyby następujące: Skalowalny w poziomie - mogę uruchomić wiele nadmiarowych kopii mikrousług, aby poradzić sobie z obciążeniem i / lub spadkiem serwera. Luźno powiązane - …

26 architecture rest api-design microservices

3

RESTful API: czasowniki HTTP ze wspólnymi lub konkretnymi adresami URL?

Czy podczas tworzenia interfejsu API RESTful należy używać czasowników HTTP dla tego samego adresu URL (jeśli jest to możliwe), czy też powinienem utworzyć określony adres URL dla akcji? Na przykład: GET /items # Read all items GET /items/:id # Read one item POST /items # Create a new item PUT …

25 rest api-design web-api

10

Projektowanie interfejsu API: podejście konkretne vs. abstrakcyjne - najlepsze praktyki?

Podczas omawiania interfejsów API między systemami (na poziomie biznesowym) w naszym zespole często występują dwa różne punkty widzenia: niektórzy wolą bardziej - powiedzmy - ogólne podejście abstrakcyjne, a inne proste „konkretne” podejście. Przykład: projekt prostego interfejsu API „wyszukiwania osoby”. konkretna wersja byłaby searchPerson(String name, boolean soundEx, String firstName, boolean soundEx, …

25 api web-services api-design

3

Czy zwrócenie kodu HTML z interfejsu API JSON jest w porządku?

W moim obecnym projekcie jestem odpowiedzialny za wdrożenie usługi polegającej na wykorzystaniu nowo utworzonych interfejsów API RESTful, udokumentowanych wyłącznie jako wsparcie dla JSON. Klient konsekwentnie wysyła żądania z nagłówkiem accept „application / json” i typem treści „application / json”. Jednak niektóre punkty końcowe wysyłają odpowiedź z typem treści HTML, nawet …

25 rest api-design json bad-code

4

Czy podczas tworzenia interfejsu API powinienem trzymać się małych funkcji i wielu połączeń, czy też kilku połączeń i dużych funkcji?

Mam platformę szynową, którą utrzymuję. Ma na nim wiele różnych aplikacji internetowych. Jednak teraz klient prosi o interfejs API, aby mógł zatrzymać użytkowników w swojej witrynie, ale skorzystać z niektórych naszych zautomatyzowanych zadań. Platforma służy do tworzenia aplikacji ubezpieczeniowych i umożliwia ich zakup online, a także zapewnia sposoby pobierania dokumentacji …

25 web-applications ruby-on-rails api-design

2

Czy powinienem tworzyć własne kody stanu HTTP? (a la Twitter 420: Enhance Your Calm)

To pytanie zostało przeniesione z błędu serwera, ponieważ można na nie odpowiedzieć w programie Software Engineering Stack Exchange. Migrował 6 lat temu . Obecnie wdrażam API HTTP, mój pierwszy w historii. Spędziłem dużo czasu, szukając kodów stanu HTTP na stronie Wikipedii, ponieważ jestem zdeterminowany, aby zaimplementować odpowiednie kody dla odpowiednich …

24 api-design http

3

Zalecany kod stanu HTTP dla odpowiedzi „przekroczono limit planu”

Projektuję interfejs API REST dla projektu, w którym użytkownicy są zawsze w jednym z kilku „planów” - każdy plan określa pewne ograniczenia zasobów, takie jak maksymalna liczba użytkowników, których może mieć konto lub maksymalna liczba danych, które mogą przesłać. Po osiągnięciu jednego z tych limitów użytkownicy mogą zaktualizować swoje plany …

24 rest api-design http

Pytania otagowane jako api-design