Presentación de actualizaciones en la experiencia de la API REST

La autora de esta publicación es Jessie Huang, jefa de programas del equipo de docs.microsoft.com.

Nos complace anunciar el lanzamiento de dos mejoras clave en la experiencia de REST en docs.microsoft.com:

  • Versión preliminar del explorador de la API REST: una manera sencilla de buscar y detectar API REST desarrolladas por Microsoft.
  • Probar REST: una experiencia interactiva que le permite probar las API REST directamente en su explorador web favorito.

Detección de API REST en una ubicación

Si ya está familiarizado con cualquiera de nuestras experiencias del explorador de API, como la de .NET, PowerShell, Python o JavaScript, se sentirá como en casa con esta nueva versión, ya que le permite obtener rápidamente documentación para una amplia variedad de API REST sin tener que depender de una experiencia de búsqueda menos centrada. El explorador de API le permite empezar a trabajar rápidamente, ya que encuentra la API correcta en cuestión de segundos.

Anteriormente, si quería encontrar documentación específica de la API REST en docs.microsoft.com, probablemente usaba nuestra búsqueda en todo el sitio o alguno de los componentes de navegación de las páginas de contenido, como la tabla de contenido. Esto puede llevar mucho tiempo, sobre todo cuando sabe exactamente qué está buscando. Por eso, nos propusimos hacerlo más fácil.

A partir de hoy, puede detectar API REST de Microsoft de una manera mucho más eficaz desde una ubicación centralizada: https://docs.microsoft.com/rest/api. Solo tiene que seleccionar un servicio en la lista desplegable para buscar todas las API de servicio disponibles:

Detección de API REST mediante la selección de productos.

¿Necesita ahorrarse un clic? Para algunas de las API que se usan con más frecuencia, siempre puede contar con los filtros rápidos. Al hacer clic en una de ellos, se mostrará al instante el conjunto completo de API para un servicio determinado en su versión más reciente:

Detección de API REST mediante un filtro rápido en la página.

Hemos diseñado la experiencia de búsqueda de una manera que le permita encontrar la información de API necesaria, tanto si conoce las palabras clave exactas como si no, e incluso si no sabe en qué servicio se encuentra. De forma predeterminada, buscaremos en todas las API documentadas en docs.microsoft.com. La búsqueda se realizará solo cuando se seleccione un servicio, dentro del ámbito de dicho servicio.

Búsqueda de API REST mediante una sola palabra clave.

¿Necesita buscar varias palabras clave a la vez? También puede hacerlo.

Búsqueda de API REST mediante varias palabras clave.

Pruebe las API REST de Azure en el explorador

¿Ha encontrado una API de Azure de su interés, pero no sabe si es lo que necesita para ayudarle a crear su escenario? No se preocupe, porque a partir de hoy puede probar las API REST de Azure directamente en el explorador, en docs.microsoft.com.

Lo único que debe hacer es presionar el botón verde Probar:

Probar REST para iniciar la experiencia.

Una vez que seleccione Probar para una API REST, se le llevará a una vista centrada, lo que le permitirá experimentar con diferentes valores de parámetro u otro cuerpo de la solicitud. Puede cambiar fácilmente el contexto del artículo mediante el botón de menú Contenido situado en la esquina superior izquierda de la página:

Probar REST para cambiar el contexto del artículo.

Queremos conocer su opinión

Tenemos previsto implementar muchas mejoras a corto plazo, por lo que esta experiencia no es en ningún caso final. Por ejemplo, habilitaremos la opción Probar no solo para las API REST de Azure. Nos gustaría que nos diese su opinión sobre cómo podemos mejorar la experiencia de REST. Para ello, solo tiene que abrir una incidencia nueva y nos pondremos en contacto con usted lo antes posible.

También puede seguir nuestra cuenta de Twitter para estar al día de las últimas novedades y notificaciones.

¿Sueña con mejorar el mundo de los desarrolladores? Únase a nuestro equipo.