Domande con tag 'api-design'

4
risposte

Includere un collegamento alla relativa documentazione nel messaggio di errore?

Creiamo una libreria commerciale e esempi di codice che vengono utilizzati da sviluppatori esterni. Abbiamo una documentazione (chiusa, disponibile per gli utenti registrati) che spiega ampiamente come utilizzare la libreria. Molti sviluppato...
posta 26.06.2017 - 12:45
1
risposta

Perché gli operatori Null-Safe (ad esempio "operatore Elvis") sono stati rifiutati come parte del "Progetto Coin" di Java 7?

Una delle funzionalità proposte per "Project Coin" di Java 7 era "l'operatore Elvis". Un rapporto di una presentazione JavaOne 2009 su Project Coin lo ha descritto come tale: One of the "small features" covered in this presentation is the...
posta 19.10.2017 - 17:23
2
risposte

Devo essere permissivo dei parametri sconosciuti?

Sto progettando un'API RESTful e ho affrontato il problema del titolo, riformulato per chiarezza: Devo fallire velocemente se un client invia un parametro non riconosciuto? Ad esempio, http://example.com/api/foo?bar=true&paula=bean...
posta 01.03.2016 - 12:37
3
risposte

API CRUD: come si specificano i campi da aggiornare?

Supponiamo che tu abbia una sorta di struttura dati, che viene mantenuta in una sorta di database. Per semplicità, chiamiamo questa struttura dati Person . Ora hai il compito di progettare un'API CRUD, che consente ad altre applicazioni di c...
posta 13.09.2015 - 12:58
2
risposte

Alert System Architecture

Vorrei creare un sistema che gestisca i messaggi di avviso di vari programmi e possa elaborare tali avvisi per i consumatori down-wind via e-mail. Tutto ciò sarebbe contenuto su una rete interna. Penso di volere che l'architettura di base ass...
posta 30.03.2018 - 16:52
1
risposta

Dal libro REST vs Too Many Requests

Dal commento di Roy Fielding sul suo proprio articolo che denigra falso apis REST : A truly RESTful API looks like hypertext. Every addressable unit of information carries an address, either explicitly (e.g., link and id attributes) or...
posta 20.07.2016 - 08:59
3
risposte

Ultime modifiche alle API: come posso semplificare la transizione per gli utenti della biblioteca?

In passato, ho utilizzato il metodo standard per aggiungere @Deprecated annotazioni ai metodi API che verranno rimossi in una versione successiva. Ora sto preparando una versione principale per una libreria, con molte parti API rimosse e...
posta 12.05.2016 - 19:19
2
risposte

Aggiunta a un insieme finito di opzioni; un cambio di rottura dell'API?

Prendi un endpoint dell'API HTTP che sputa il seguente modello di risposta: { "type": "Dog", "name": "Jessi", ... } Il campo type è stato descritto nella documentazione come uno di Dog , Cat o Fish . Aggiung...
posta 03.02.2017 - 13:01
6
risposte

Un'API HTTP dovrebbe sempre restituire un corpo?

Esiste una sorta di standard sulle risposte alle API HTTP? Dopo aver letto questo discorso discale ho iniziato a chiedermi. Stiamo sviluppando la nostra pubblica API HTTP JSON nel mio lavoro, e non restituiamo nulla quando non è strettament...
posta 12.09.2013 - 15:32
2
risposte

Perché le eccezioni controllate e non controllate sono chiamate "la controversia" nel tutorial Oracle Oracle?

Sono nuovo di Java e stavo leggendo la sua documentazione sulle eccezioni , e specialmente < a href="https://docs.oracle.com/javase/tutorial/essential/exceptions/runtime.html"> Pagina Eccezioni non controllate - Controversia . La linea di fo...
posta 20.07.2016 - 13:57