Domande con tag 'api-design'

5
risposte

I costruttori dovrebbero mai essere usati solo per gli effetti collaterali?

Riepilogo: Perché è sbagliato progettare un costruttore solo per i suoi effetti collaterali e quindi utilizzare il costruttore senza assegnare mai il suo valore di ritorno a una variabile? Sto lavorando a un progetto che prevede la modellazio...
posta 04.03.2017 - 05:30
5
risposte

Dovremmo personalizzare le API per il cliente o chiedere al cliente di utilizzare quello esistente?

Sono un unico sviluppatore e di recente ho scritto una nuova applicazione web sotto forma di API con Swagger e front-end. Questo era il modo in cui i clienti potevano usare l'API da soli, di solito forscripting. È quasi in fase di completamen...
posta 24.10.2018 - 17:00
2
risposte

Scegliere tra parole con diverse grafie per i nomi di funzioni

Una domanda mi ha infastidito per un po ': quando si sviluppano progetti internazionali, è logico usare l'inglese come lingua di riferimento poiché è la lingua che la maggior parte della gente comprende. Tuttavia, come si può scegliere di nom...
posta 26.03.2013 - 13:31
4
risposte

MVC e servizio API RESTful

MVC è piuttosto semplice. C'è un modello, un controller e una vista. Quando creiamo un sito web, tutto si unisce quando il client invia la richiesta parola chiave REST al server - > il server corrisponde all'URL richiesto all'azione del cont...
posta 13.07.2016 - 14:08
2
risposte

Modifica della firma del metodo mantenendo la compatibilità con le versioni precedenti

Ho ereditato un'API da mantenere. Gli utenti possono passare una funzione di callback alla classe che viene chiamata su qualche evento. La funzione di callback è attualmente passata in un singolo argomento. Devo modificare la firma previst...
posta 03.12.2014 - 20:11
3
risposte

Linee guida per il posizionamento dei metodi API?

Esistono linee guida per l'inserimento di metodi in API quando il posizionamento non è evidente? Esempio: ho classi A e B e un metodo X . Il lavoro svolto può essere formulato in due modi: A does X with B B does X...
posta 04.03.2012 - 17:23
3
risposte

OTTIENI stato risorsa con corpo JSON o codice HTTP

Voglio fornire a mi di riposo il mio servizio iot per leggere lo stato di uno sprinkler on / off. Finora ho trovato due soluzioni: GET /api/sprinkler che restituisce 204 se su e 404 se off GET /api/sprinkler che restitu...
posta 19.06.2016 - 13:19
2
risposte

Una funzione per produrre una coppia o una funzione per articolo?

Ho un dilemma. Diciamo che ho un AST che descrive alcune grammatiche, per esempio. Posso scrivere una funzione per stringere questo AST in un formato BNF leggibile dall'uomo o generare un parser da esso. Posso e voglio generare entrambi da dato...
posta 17.11.2016 - 12:30
2
risposte

API REST - proprietà omesse nella richiesta POST: come devono essere gestite?

Dato il seguente scenario: Entità insegnante { "id": "1234", "name": "Mr. Didactic", "Subject": "History", "Classroom": "1A" } Endpoint dell'API REST: /teacher/id/1234 Diciamo che invio una richiesta POST (aggiornament...
posta 11.02.2016 - 23:58
3
risposte

API nidificate - Discussione sulle buone pratiche

Supponiamo che tu abbia un evento e desideri aggiungere membri a quell'evento. Lo progetteresti come event/:event-id/members/ ? o basta renderlo '/members' dove si specifica l'ID evento nel corpo POST? Trattare con entità nidifica...
posta 07.11.2017 - 11:19