¿Cuáles son las mejores prácticas para la página raíz de una API REST?
https://stackoverflow.com/questions/2894723
-
04-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianPregunta
Me gustaría saber si hay algunas mejores prácticas sobre el punto final de la raíz para un servicio web REST? Es decir, debe ser un corto documentación sobre el uso de la propia API? ¿Debería ser un documento XML que describe todos los métodos disponibles? En caso de que sólo se volverá "método desconocido"?
Solución
Esta pregunta como pidió no está claro. Yo supongo que significa algo así como un directorio que todos los métodos de la API están bajo. Por ejemplo, el directorio raíz de la API de Flickr sería http://api.flickr.com/services / descanso / .
Para un ejemplo de un proyecto que tiene acceso a la API de Flickr, ver python-flickrapi
Otros consejos
La pregunta es perfectamente claro para mí.
Creo que debe responder con 404. Si no hay ningún recurso asociado a la ruta raíz, entonces no hay nada a cambio.
Si usted siente que 404 no es útil, entonces también sería OK para volver la URL de la documentación.
1. NerdDinner utiliza WCF Data Services, que es una gran manera de aplicar correctamente los servicios REST. La razón por la que estoy a punto de eso, y no los servicios de datos de WCF es directamente porque es un sitio web público y se puede utilizar. 2. MediaWiki no es un gran ejemplo porque están pasando acciones en el URI pero es técnicamente un servicio REST y el espectáculo de una gran cantidad de ideas interesantes.
el punto de API REST rootend es el la API definido para el primero es decir barra "/" de la dirección URL después de que el despachador-servlet. Contiene toda la GET para la lista de recursos (sobre todo el GET para todas las tablas de la base) Esta lista contiene, además, todos los artículos y en solo artículo no será DELETE, PUT / parche y URL AUTO get. Con lo que la aplicación de HATEOS.
REST se supone que es uno mismo describiendo lo que tener la raíz mostrar un error es un mal diseño en mi opinión. Me gusta la raíz para contener la información que le permite navegar por el resto de la API. Así, por ejemplo, la raíz puede contener un enlace a una lista de categorías de productos de la que el usuario de la API puede seleccionar una categoría y luego una lista de productos, etc. Un auto que describe medios menos documentación API para escribir y mantener actualizado !!
