Ocena REST API w Node.js

Projekty użytkowników
sefinek
sefinek

Witam. Niedawno napisałem swój drugi interfejs API (wersja beta) tyle, że już w innym języku. Tak, zdaję sobie sprawę, że to, co stworzyłem, nie wymaga dużych umiejętności.

Pytanie do was. Jak państwo ocenia moją wykonaną pracę? Index: https://api.skiffybot.xyz Endpoints: https://api.skiffybot.xyz/api/v1 Zależy mi na merytorycznej opinii, ze względu na to, że chce napisać wrapper dla menadżera pakietów npm.

Przyjmę wszelką krytykę. Mam nadzieje, że wszystko jest czytelne i jak najbardziej sprawne. Jedyna rzecz, która nie jest w pełni sprawna to ratelimity. Aplikacja się zlagowywuje na kilka chwil po wysłaniu około 1000 requestów do serwera - endpoint /api/v1/filter/blur.

Wszystkie wskazane przez państwa błędy, zostaną oczywiście wyeliminowane. Pozdrawiam i życzę miłego dnia. (:

SystemZ
SystemZ Admin lvlup.pro

Daj znać co konkretnie mamy ocenić. Warto byłoby opisać dokładnie cel i zastosowanie aplikacji oraz listę tych elementów których nie jesteś pewien czy dobrze zaimplementowałeś i/lub przedstawiłeś w formie REST.

sefinek
sefinek

SystemZ:

Daj znać co konkretnie mamy ocenić. Mam na myśli:

  • czytelność pseudo dokumentacji w formie json
  • prawidłowa działalność i zabezpieczenia API
  • czy zwrócone kody statusów przez serwer są sensowne

Jeżeli się rozchodzi o działalność i zabezpieczenia to:

  • test ratelimitów
  • walidacja danych podana w adresie zapytania (/api/v1/filter/blur i /api/v1/filter/contrast)
  • wklejony link z grabberem ip przez klienta w parametrze image - /api/v1/filter/

API to jest przygotowywane pod przyszły wrapper dla menadżera paczek npm. Konkretne zastosowanie interfejsu to boty na Discordzie.

system
system

Ten temat został automatycznie zamknięty 180 dni po ostatnim wpisie. Tworzenie nowych odpowiedzi nie jest już możliwe.