Devo restituire una risposta 204 o 404 quando non viene trovata una risorsa?

Sto sviluppando un semplice servizio RESTful per tornei e programmi. Quando un torneo viene creato tramite una richiesta POST contenente un corpo JSON, il torneo viene inserito in un BiMap, dichiarato come segue in un'implementazione DAO:

private BiMap<String, Tournament> tournaments = Maps.synchronizedBiMap(HashBiMap.create());

Quando viene creato un torneo, viene restituito l'ID stringa associato in modo che l' utente possa avere riferimenti futuri di quel torneo. Può ottenere informazioni dal nuovo torneo eseguendo la seguente richiesta:

GET http://localhost:8080/eventscheduler/c15268ce-474a-49bd-a623-b0b865386f39

Ma cosa succede se non viene trovato nessun torneo con tale ID? Finora, sto restituendo una risposta 204. Bene, Jersey lo sta facendo per me quando ritorna nullda uno dei suoi metodi. Questo è il metodo che corrisponde al percorso sopra:

@Path("/{id}")
@GET
@Produces(MediaType.APPLICATION_JSON)
public Tournament getTournament(@PathParam("id") String id) {
    Optional<Tournament> optTournament = tournamentDao.getTournament(id);
    if (optTournament.isPresent())
        return optTournament.get();
    return null;
}

La mia domanda è: è corretto restituire una 204: No Contentrisposta o dovrebbe essere 404invece una risposta, poiché la risorsa non è stata trovata?

Se dovessi cambiarlo in una 404, domanda ovvia: dovrei cambiare la firma del metodo giusto? Poiché ora un torneo (di tipo Tournament) potrebbe non essere restituito, il metodo dovrebbe apparire diverso. Dovrei usare invece il Responsetipo come tipo di ritorno?

HTTP 204significa che è stato trovato qualcosa , ma è vuoto. Ad esempio, immagina di pubblicare file di registro tramite HTTP, con richieste come http://example.com/logs/[date-goes-here] . 18 maggio 2015:

• http://example.com/logs/2015-05-19 ritornerebbe HTTP 404, il che significa che non ci sono registri, perché, beh, è ​​difficile registrare il futuro.

• http://example.com/logs/2015-05-18 , tuttavia, restituirebbe o HTTP 200con le voci di registro nel contenuto della risposta o HTTP 204se il file di registro è stato creato, ma non ci sono ancora registri registrati per questo Data.

Se si fornisce nullal framework come risposta a una richiesta, si presume che sia stata trovata una voce e questa voce è vuota, quindi HTTP 204. Invece, dovresti throw new NotFoundException();indicare al framework che la voce non esiste, in modo da generare un HTTP 404.

Se dovessi cambiarlo in una 404, domanda ovvia: dovrei cambiare la firma del metodo giusto?

No, non lo fai. Questa è la cosa bella throw new NotFoundException();. Funzionerà indipendentemente dal tipo di ritorno effettivo del metodo.

Dovresti restituire un 404. Puoi farlo lanciando NotFoundException ( https://jersey.java.net/apidocs/2.6/jersey/javax/ws/rs/NotFoundException.html ).

Guarda anche questa domanda SO se devi controllare il tipo di contenuto restituito /programming/23858488/how-i-return-http-404-json-xml-response-in-jax-rs- jersey-on-tomcat

La tua richiesta è GET http://localhost:8080/eventscheduler/c15268ce-474a-49bd-a623-b0b865386f39.

Se http://localhost:8080/eventscheduler/non esiste come endpoint, è necessario restituire un 404. Si sta tentando di accedere a una risorsa ( /eventscheduler/) che non esiste. Ciò indicherebbe a un client su cui esiste un server localhost:8080, ma non c'è nulla eventschedulernell'endpoint.

Se http://localhost:8080/eventscheduler/esiste come endpoint ma le risorse richieste non sono disponibili, è appropriato un errore 5xx. Un buon esempio di questo potrebbe essere se un database non è in linea, dove potresti restituire un 503. Naturalmente, potresti voler restituire un errore 500 generico anziché un'istanza specifica.

Se http://localhost:8080/eventscheduler/esiste ma la cosa rappresentata da c15268ce-474a-49bd-a623-b0b865386f39non esiste, restituirei un 200 con un corpo che indica i dettagli. L'endpoint esiste, la richiesta fatta era totalmente valida e poteva essere elaborata, ma non c'era corrispondenza.

Se la richiesta del client all'endpoint non fosse valida, verranno visualizzati gli altri errori 4xx. È possibile indicare che il client non è autorizzato ad accedere all'endpoint o agli articoli richiesti con un 401 o 403 oppure è possibile utilizzare un 400 per indicare che la richiesta non è valida. Con uno di questi, ulteriori informazioni possono essere fornite nel corpo della risposta.