Annuncio di aggiornamenti per l'esperienza con le API REST

Questo post è stato scritto da Jessie Huang, Program Manager nel team di docs.microsoft.com.

Oggi siamo lieti di annunciare la versione di due miglioramenti chiave per l'esperienza REST su docs.microsoft.com:

  • La versione di anteprima del browser API REST è un modo semplice per cercare e individuare le API REST sviluppate da Microsoft.
  • REST Prova it-un'esperienza interattiva che consente di provare le API REST direttamente nel Web browser preferito.

Individuare le API REST in un percorso

Se si ha già familiarità con una qualsiasi delle esperienze esistenti di Browser API, ad esempio per .NET, PowerShell, Python o JavaScript, si sente subito a casa con questa nuova versione: consente di ottenere rapidamente la documentazione per un'ampia gamma di API REST senza dover basarsi su un'esperienza di ricerca meno focalizzata. Il browser API è tutto ciò che ti permette di iniziare rapidamente trovando l'API corretta in secondi.

In precedenza, se si desidera trovare una documentazione specifica dell'API REST in docs.microsoft.com, potrebbe essere necessario cercarla tramite la ricerca a livello di sito o usare uno dei componenti di spostamento nelle pagine del contenuto, ad esempio il sommario. Questo può richiedere molto tempo, soprattutto in situazioni in cui si conosce esattamente ciò che si sta cercando. Volevamo rendere questo più semplice.

A partire da oggi, è possibile individuare le API REST Microsoft in modo molto più efficiente, da una posizione centralizzata - https://docs.microsoft.com/rest/api. È sufficiente selezionare un servizio dall'elenco a discesa per trovare tutte le API del servizio disponibili:

Individuare le API REST selezionando prodotti

È necessario salvare un clic? Per alcune DELLE API usate più frequentemente, è sempre possibile contare su Filtri rapidi : facendo clic su uno di essi verrà immediatamente visualizzato il set completo di API per un determinato servizio, per la versione più recente:

Individuare le API REST tramite filtro rapido nella pagina

Abbiamo progettato l'esperienza di ricerca in un modo che consente di trovare le informazioni api necessarie se si conoscono le parole chiave esatte o meno , o anche se non si conosce il servizio in cui si trova! Per impostazione predefinita, verranno eseguite ricerche in tutte le API documentate in docs.microsoft.com. Solo quando viene selezionato un servizio, la ricerca verrà eseguita all'interno dell'ambito di tale servizio.

Ricerca di API REST in base a una singola parola chiave

È necessario cercare più parole chiave contemporaneamente? È anche possibile farlo!

Ricerca di API REST in base a più parole chiave

Provare le API REST di Azure nel browser

È stata trovata un'API di Azure di interesse, ma non si sa se è abbastanza cosa è necessario creare lo scenario? Non preoccuparti, perché a partire da oggi è possibile provare le API REST di Azure direttamente nel browser, in docs.microsoft.com!

Tutto quello che devi fare è premere il pulsante prova verde:

Prova REST - Avvio dell'esperienza

Dopo aver selezionato Prova per un'API REST, verrà visualizzata una visualizzazione incentrata, consentendo di sperimentare con valori di parametro diversi o corpo della richiesta. È possibile modificare facilmente il contesto dell'articolo usando il menu Hamburger contenuto nell'angolo in alto a sinistra della pagina:

Prova REST - Modifica del contesto dell'articolo

Vuoi che il tuo feedback

Esistono molti miglioramenti pianificati per l'implementazione in breve termine, pertanto questa esperienza non è definitiva, ad esempio si abiliterà Prova non solo per le API REST di Azure. Vogliamo che ci dici come possiamo migliorare la nostra esperienza REST - apriamo un nuovo problema e torneremo al più presto possibile.

È anche possibile seguire l'account Twitter per le notifiche e gli aggiornamenti più recenti.

Si vuole contribuire a semplificare le attività per gli sviluppatori? È possibile entrare a far parte del nostro team!