Pytania otagowane jako api-design

Interfejs programowania aplikacji (API) omawia najlepsze praktyki tworzenia bibliotek przeznaczonych do ogólnego użytku lub użytku publicznego.

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 


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 …

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 


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 …


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, …

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 - …


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, …

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 …

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 …


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 

Korzystając z naszej strony potwierdzasz, że przeczytałeś(-aś) i rozumiesz nasze zasady używania plików cookie i zasady ochrony prywatności.
Licensed under cc by-sa 3.0 with attribution required.