Pytania otagowane jako api-design

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

5
Jak najlepiej reprezentujesz dwukierunkową synchronizację w interfejsie API REST?
Zakładając, że w systemie jest aplikacja sieci Web z zasobem i odniesienie do aplikacji zdalnej z innym podobnym zasobem, w jaki sposób reprezentujesz dwukierunkową akcję synchronizacji, która synchronizuje zasób „lokalny” z zasobem „zdalnym”? Przykład: Mam interfejs API reprezentujący listę czynności do wykonania. GET / POST / PUT / DELETE / …
5
Funkcja zwraca true / false vs. void w przypadku powodzenia i zgłasza wyjątek w przypadku niepowodzenia
Buduję interfejs API, funkcję, która przesyła plik. Ta funkcja nie zwróci niczego / unieważni, jeśli plik został poprawnie przesłany i zgłasza wyjątek, gdy wystąpił jakiś problem. Dlaczego wyjątek, a nie tylko fałsz? Ponieważ wewnątrz wyjątku mogę określić przyczynę niepowodzenia (brak połączenia, brak nazwy pliku, nieprawidłowe hasło, brak opisu pliku itp.). …
2
Czy zawsze należy wiedzieć, co robi interfejs API, patrząc tylko na kod?
Ostatnio opracowuję własny interfejs API i dzięki temu zainwestowanemu zainteresowaniu projektowaniem interfejsu API byłem bardzo zainteresowany, jak mogę ulepszyć swój interfejs API. Jednym z aspektów, który pojawiał się kilka razy jest (nie przez użytkowników mojego API, ale podczas mojej dyskusji na ten temat): należy wiedzieć, patrząc na kod wywołujący API, …
4
Dlaczego interfejsy API kolekcji Java nie mają ostatniej metody? [Zamknięte]
Zamknięte . To pytanie jest oparte na opiniach . Obecnie nie przyjmuje odpowiedzi. Chcesz poprawić to pytanie? Zaktualizuj pytanie, aby można było na nie odpowiedzieć faktami i cytatami, edytując ten post . Zamknięte 5 lat temu . Dotyczy to zamówionych kolekcji, np. Java.util.List. Dlaczego projektanci języków nie zastosowali ostatniej metody? …
19 java  api-design 
2
Projekt interfejsu API REST: wiele wywołań vs. pojedyncze wywołanie interfejsu API
Opracowujemy interfejs Rest API dla witryny eCommerce, który będzie wykorzystywany przez aplikacje mobilne. Na stronie głównej aplikacji musimy wywoływać wiele zasobów, takich jak suwaki, najlepsze marki, najlepiej sprzedające się produkty, popularne produkty itp. Dwie opcje wykonywania połączeń API: Pojedyncze połączenie: www.example.com/api/GetAllInHome Wiele połączeń: www.example.com/api/GetSliders www.example.com/api/GetTopBrands www.example.com/api/GetBestSellingProducts www.example.com/api/GetTrendingProducts Jakie jest najlepsze …
19 rest  api  api-design  url 
4
Abstrakcja bazy danych - czy jest przesadzana?
Po zetknięciu się z licznymi warstwami abstrakcji bazy danych zaczynam się zastanawiać, o co chodzi w tym, że każda biblioteka wymyśla swój własny paradygmat dostępu do danych. Odbieranie nowego DAL przypomina uczenie się nowego języka od nowa, kiedy zwykle wszystko, co chcę zrobić, to po prostu przekonać warstwę do wygenerowania …
18 database  sql  api-design  dsl 
4
Dlaczego ciąg Java String nie ma metod manipulacji ciągiem statycznym?
Dlaczego projektanci Java nie stworzyli statycznych wersji metod manipulacji ciągami w java.lang.Stringklasie? Odnoszę się do następujących metod, ale pytanie można rozszerzyć również na inne metody niestatyczne w klasie. concat(String) substring(int, int) replace(char, char) toLowerCase() replace(CharSequence, CharSequence) toLowerCase(Locale) replaceAll(String, String) toString() replaceFirst(String, String) toUpperCase() split(String) toUpperCase(Locale) split(String, int) trim() substring(int) Posiadanie …
17 java  api-design  null 
3
Wykrywanie niezliczonych „automatów stanowych”
Właśnie przeczytałem interesujący artykuł zatytułowany Robi się zbyt słodki z zyskiem c # Zastanawiałem się, jaki jest najlepszy sposób na wykrycie, czy IEnumerable jest faktyczną kolekcją, którą można wyliczyć, czy też jest maszyną stanu wygenerowaną za pomocą słowa kluczowego fed. Na przykład możesz zmodyfikować DoubleXValue (z artykułu) na coś takiego: …
17 c#  api-design 
3
Kiedy powinienem używać string_view w interfejsie?
Korzystam z biblioteki wewnętrznej, która została zaprojektowana tak, aby naśladować proponowaną bibliotekę C ++ , a czasami w ciągu ostatnich kilku lat widzę, że jej interfejs zmienił się z używania std::stringna string_view. Dlatego sumiennie zmieniam kod, aby dostosować się do nowego interfejsu. Niestety, muszę przekazać parametr std :: string i …
2
Kiedy używać zagnieżdżonych zasobów w interfejsie API RESTful
Mam dwa zasoby: użytkowników i linki. Użytkownicy mogą mieć kilka linków powiązanych z nimi. Zaprojektowałem mój interfejs API RESTful, abyś mógł uzyskać dostęp do linków powiązanych z użytkownikiem o następującym identyfikatorze URI: /users/:id/links Jednak zawsze muszę mieć identyfikator URI dla samych łączy - czasami mogę chcieć wszystkich łączy, niezależnie od …
16 api  rest  api-design 
3
Wersjonowanie interfejsów API REST. Każdy interfejs API ma własną wersję
Bardzo często określa się wersje interfejsów API REST w adresie URL, szczególnie na początku ścieżki, tj. Coś w stylu: POST /api/v1/accounts GET /api/v1/accounts/details Jednak nie widziałem żadnego projektu, w którym wersja jest powiązana z każdym interfejsem API. Innymi słowy, utrzymujemy wersję każdego interfejsu API osobno. to znaczy: POST /api/accounts/v2 GET …
1
RESTful API i i18n: jak zaprojektować odpowiedź?
Projektujemy interfejs API RESTful przeznaczony głównie do zaspokojenia potrzeb jednego klienta. Ze względu na bardzo szczególne okoliczności ten klient musi składać jak najmniej zapytań. Interfejs API obsługuje i18n za pomocą nagłówka Accept-Language w żądaniach. Działa to dla wszystkich rzeczy, które klient musi zrobić, z wyjątkiem jednej funkcji, w której klient …
15 rest  api  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.