Ingegneria software api-design

14

Dovresti scrivere il tuo back-end come API?

Ho avuto una discussione accesa oggi sulla nostra applicazione MVC. Abbiamo un sito Web scritto in MVC ( ASP.NET ) e di solito segue lo schema di fare qualcosa nella vista -> premi il controller -> il controller crea un modello (chiama un Manager che ottiene i dati, costruisce il …

322 mvc asp.net-mvc api-design

4

Che cos'è un livello anticorruzione e come viene utilizzato?

Sto cercando di capire cosa significhi davvero il livello anticorruzione. So che è un modo per passare / aggirare il codice legacy o API errate. Quello che non capisco è come funziona e ciò che lo rende una separazione netta dallo strato indesiderabile. Ho fatto qualche ricerca, ma non riesco …

151 design-patterns api-design legacy bad-code

7

Come si inseriscono le ricerche in un'interfaccia RESTful?

Quando si progetta un'interfaccia RESTful, la semantica dei tipi di richiesta è considerata vitale per il progetto. OTTIENI : elenca la raccolta o recupera l'elemento PUT - Sostituisce la raccolta o l'elemento POST : crea una raccolta o un elemento ELIMINA - Bene, erm, elimina la raccolta o l'elemento Tuttavia, …

137 design rest api-design http-request

14

La soluzione dovrebbe essere il più generica possibile o il più specifica possibile?

Supponiamo di avere un'entità con l'attributo "tipo". Potrebbero esserci più di 20 tipi possibili. Ora mi viene chiesto di implementare qualcosa che consenta di cambiare il tipo da A-> B, che è l'unico caso d'uso. Quindi dovrei implementare qualcosa che consenta modifiche arbitrarie di tipo purché siano tipi validi? O …

124 programming-practices api-design requirements

5

Devo restituire uno stato HTTP 400 (richiesta non valida) se un parametro è sintatticamente corretto, ma viola una regola aziendale?

Dì che ho un endpoint REST che accetta un numero intero come parametro: /makeWaffles?numberOfWaffles=3 In questo caso, voglio che il numero sia positivo perché non riesco a creare un numero negativo di waffle (e richiedere 0 waffle è una perdita di tempo). Quindi voglio rifiutare qualsiasi richiesta che non contenga …

56 api-design http

9

Dovresti proteggerti da valori imprevisti da API esterne?

Supponiamo che stai codificando una funzione che accetta input da un'API esterna MyAPI. L'API esterna MyAPIha un contratto che afferma che restituirà a stringo a number. E 'consigliato a guardia contro le cose come null, undefined, boolean, ecc anche se non fa parte delle API di MyAPI? In particolare, dal …

51 design api api-design web-services functions

10

Quale dovrebbe essere il codice di stato http per l'errore "Servizio non disponibile nella tua zona"?

Il nostro servizio è in 5 città in questo momento. Se qualcuno prova a chiamare la nostra API di servizio da qualsiasi altra città, vogliamo lanciare questo errore Service not available in your area. La domanda è: quale sarebbe il codice http appropriato per questo errore? 503 servizio non disponibile …

51 api api-design http

14

Progettazione API RESTful. Cosa devo restituire se non ci sono righe?

Attualmente sto codificando un'API per un social network con Slim Framework. La mia domanda è: quali sono le migliori pratiche quando non ci sono righe da restituire nella struttura json? Diciamo che questa chiamata / v1 / get / movies restituisce 2 righe dai nomi dei film da tavolo: [ …

50 programming-practices rest api-design json

6

Molte piccole richieste vs. poche grandi richieste (Progettazione API)

Attualmente sto lavorando a un progetto con un'organizzazione come segue: Client : ottiene i dati dal server principale tramite API REST. Server : richiede dati da vari altri server tramite API di terze parti API di terze parti - Servizi fuori dal mio controllo che forniscono dati al server (Reddit, …

49 design rest api-design server

3

Perché il metodo PATCH non è idempotente?

Mi chiedevo questo. Supponiamo che io abbia una userrisorsa con ide namecampi. Se voglio aggiornare un campo potrei semplicemente fare una richiesta PATCH alla risorsa in questo modo PATCH /users/42 {"name": "john doe"} E quindi l'applicazione aggiornerà il nome dell'utente 42. Ma perché se ripeto questa richiesta il risultato sarebbe …

48 rest api-design http web-api

6

Quanto è necessario seguire le pratiche di programmazione difensiva per il codice che non sarà mai reso pubblico?

Sto scrivendo un'implementazione Java di un gioco di carte, quindi ho creato un tipo speciale di Collection che sto chiamando Zone. Tutti i metodi di modifica di Java's Collection non sono supportati, ma esiste un metodo nell'API Zone move(Zone, Card), che sposta una scheda da una determinata zona a se …

45 java programming-practices data-structures api-design

3

Cosa c'è di così brutto nel DOM?

Continuo a sentire la gente (Crockford in particolare) che dice che il DOM è un'API terribile, ma non giustifica davvero questa affermazione. A parte le incongruenze tra browser, quali sono alcuni dei motivi per cui il DOM è considerato così male?

42 javascript api api-design dom

8

Perché java.util.ArrayList consente di aggiungere null?

Mi chiedo perché java.util.ArrayListpermetta di aggiungere null. C'è un caso in cui vorrei aggiungere nulla un ArrayList? Sto ponendo questa domanda perché in un progetto avevamo un bug in cui un po 'di codice si stava aggiungendo nullal codice ArrayListed era difficile individuare dove fosse il bug. Ovviamente è NullPointerExceptionstato …

41 java api-design collections

1

null vs chiave mancante nella risposta API REST [chiuso]

Diciamo nella mia applicazione, alcuni utenti ci danno il loro cognome e altri no. In una risposta API REST, quale corpo è preferito: Con un valore "null": {"firstName": "Bob", "lastName": null} O solo una chiave mancante: {"firstName": "Bob"}

41 rest api-design json

11

Un'API REST dovrebbe restituire un errore del server interno 500 per indicare che una query fa riferimento a un oggetto che non esiste?

Sto lavorando con un'API REST che risiede su un server che gestisce i dati per una moltitudine di dispositivi IoT. Il mio compito è interrogare il server utilizzando l'API per raccogliere informazioni specifiche sulle prestazioni di tali dispositivi. In un caso, ottengo un elenco dei dispositivi disponibili e dei relativi …

39 api-design error-handling http-response

Domande taggate «api-design»