Quali sono le migliori pratiche per la pagina radice di un API REST?
https://stackoverflow.com/questions/2894723
-
04-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianDomanda
Vorrei sapere se c'è qualche buone pratiche circa l'endpoint principale per un servizio web REST? Voglio dire, dovrebbe essere una documentazione breve l'utilizzo delle API per sé? Dovrebbe essere un documento XML che descrive tutti i metodi disponibili? Dovrebbe restituire solo "metodo sconosciuto"?
Soluzione
Questa domanda come richiesto non è chiaro. Direi che significa qualcosa come una directory che tutti i metodi API sono sotto. Ad esempio, la directory radice del Flickr API sarebbe http://api.flickr.com/services / resto / .
Per un esempio di un progetto che accede il Flickr API, vedi python-flickrapi
Altri suggerimenti
La domanda è perfettamente chiaro per me.
Credo che dovrebbe rispondere con 404. Se non v'è alcuna risorsa associata al percorso principale, quindi non c'è nulla da ritorno.
Se si ritiene che 404 non è utile, allora sarebbe anche OK per tornare l'URL della documentazione.
1. NerdDinner utilizza WCF Data Services, che è un ottimo modo per implementare correttamente i servizi RESTful. Il motivo per cui sono punto a questo, e non servizi dati WCF direttamente è perché si tratta di un sito web pubblico e lo si può utilizzare. 2. MediaWiki non è un grande esempio perché stanno passando azioni nel URI, ma è tecnicamente un servizio RESTful e spettacolo di un sacco di idee interessanti.
punto rootend di REST API è l'API definito per la prima cioè barra "/" dell'URL dopo il dispatcher-servlet. Contiene tutte le GET per l'elenco delle risorse (soprattutto la get per tutte le tabelle del database) questa lista contiene inoltre tutti gli elementi e in un'unica voce ci sarà DELETE, PUT / PATCH e URL AUTO get. Rendendo così l'attuazione di HATEOS.
REST si suppone che sia auto descrivendo in modo da avere la radice mostrano un errore è cattiva progettazione a mio parere. Mi piace la radice di contenere le informazioni che vi permette di navigare il resto delle API. Così, per esempio la radice potrebbe contenere un link a un elenco di categorie di prodotti da cui l'utente API può selezionare una categoria e poi un elenco di prodotti, ecc Un auto che descrive mezzi API meno documentazione di scrivere e tenere aggiornato !!
