Apresentamos as Atualizações à Experiência de API REST
Esta publicação foi escrita por Jessie Huang, Gestora de Programas da equipa de docs.microsoft.com.
Hoje, temos o prazer de anunciar o lançamento de duas melhorias fundamentais para a experiência REST no docs.microsoft.com:
- A versão de pré-visualização do Browser da API REST– uma forma fácil de pesquisar e descobrir APIs REST desenvolvidas pela Microsoft.
- REST Experimente - uma experiência interativa que lhe permite experimentar as APIs REST diretamente no seu browser favorito.
Descobrir APIs REST numa Única Localização
Se já estiver familiarizado com qualquer uma das nossas experiências existentes do Browser de API, como esta para .NET, PowerShell, Python ou JavaScript, sentir-se-á em casa com esta nova versão. Permite-lhe obter rapidamente documentação para uma grande variedade de APIs REST sem ter de depender de uma experiência de pesquisa menos focada. O Browser de API tem tudo a ver com o seu caminho rapidamente ao encontrar a API certa em segundos.
Anteriormente, se quisesse encontrar documentação específica da API REST no docs.microsoft.com, talvez tivesse de procurá-la através da nossa pesquisa ao nível do site ou utilizar qualquer um dos componentes de navegação em páginas de conteúdo, como o índice. Isso pode ser demorado, especialmente em situações em que se sabe exatamente o que procura. Queríamos facilitar as coisas.
A partir de hoje, pode descobrir as APIs REST da Microsoft de uma forma muito mais eficiente, a partir de uma localização centralizada – https://docs.microsoft.com/rest/api. Basta selecionar um serviço na lista pendente para encontrar todas as APIs de serviço disponíveis:
Precisa de guardar um clique? Para algumas das APIs utilizadas mais frequentemente, pode sempre contar com Filtros Rápidos . Clicar numa delas irá apresentar instantaneamente o conjunto abrangente de APIs para um determinado serviço, para a versão mais recente:
Concebemos a experiência de pesquisa de uma forma que lhe permite encontrar as informações de API necessárias, quer saiba ou não as palavras-chave exatas ou não, ou mesmo se não souber o serviço em que se encontra! Por predefinição, vamos procurar em todas as APIs documentadas no docs.microsoft.com. Apenas quando um serviço é selecionado, a pesquisa ocorrerá no âmbito desse serviço.
Precisa de procurar várias palavras-chave ao mesmo tempo? Também podes fazer isso!
Experimentar as APIs REST do Azure no Seu Browser
Encontrou uma API do Azure de interesse, mas não sabe se é bem o que precisa para o ajudar a criar o seu cenário? Não se preocupe, porque a partir de hoje pode experimentar as APIs REST do Azure diretamente no browser, no docs.microsoft.com!
Tudo o que precisa de fazer é premir o botão verde Experimentar :
Depois de selecionar Experimentar para uma API REST, será direcionado para uma vista focada, permitindo-lhe experimentar diferentes valores de parâmetros ou corpo do pedido. Pode alterar facilmente o contexto do artigo ao utilizar o menu de opções Conteúdos no canto superior esquerdo da página:
Queremos os seus comentários
Existem muitas melhorias que planeamos implementar a curto prazo, pelo que esta experiência não é de forma alguma final, por exemplo, vamos ativar Experimentar não só para as APIs REST do Azure. Queremos que nos diga como podemos melhorar a nossa experiência REST. Abra um novo problema e voltaremos a contactá-lo o mais rapidamente possível.
Também pode seguir a nossa conta do Twitter para obter as mais recentes atualizações e notificações!
Sonha em tornar o mundo melhor para os programadores? Junte-se à nossa equipa!