Me gustaría saber si hay algunas mejores prácticas sobre el endpoint raíz para un servicio web REST. Quiero decir, ¿debería ser una breve documentación sobre el uso de la API en sí? ¿Debería ser un documento XML que describa todos los métodos disponibles? ¿Debería devolver solo el "método desconocido"?¿Cuáles son las mejores prácticas para la página raíz de una API REST?
Esta pregunta formulada no está clara. Supongo que significa algo así como un directorio en el que se encuentran todos los métodos de API. Por ejemplo, el directorio raíz de la API de Flickr sería http://api.flickr.com/services/rest/.
Para un ejemplo de un proyecto que accede a la API Flickr, ver python-flickrapi
quiero decir en el otro lado ... una vista de cómo se ven los archivos para llamar a la aplicación flickr desde una aplicación web ... – adam
El punto de referencia de la API REST es la API definida para la primera barra, es decir, "/" de la url después del servlet del despachador. Contiene todo el GET para la lista de recursos (principalmente el obtener para todas las tablas de la base de datos) esta lista contiene además todos los elementos y en un solo elemento habrá DELETE, PUT/PATCH y SELF get URL. Por lo tanto, hacer la implementación de HATEOS.
La pregunta está perfectamente clara para mí.
Creo que debería responder con 404. Si no hay ningún recurso asociado con la ruta de la raíz, no hay nada que devolver.
Si cree que 404 no es útil, entonces también estaría bien devolver la URL de la documentación.
¡esta es una pregunta mal definida! Por favor, proporcione más detalles –