A API GitHub

cURL

Às vezes você quer acessar rapidamente uma informação da API do GitHub sem precisar escrever um programa. Ou quando você quer acessar um HTTP request headers e content. Ou quando você quer testar a implementação de uma biblioteca e precisa confirmar se você está fazendo tudo certo. Nestas situações, cURL é uma simples ferramenta de HTTP que serve bem para isto. cURL é uma boa ferramenta Unix, é um programa pequeno com um propósito específico e intencionalmente limitado com recursos para acessar servidores HTTP. Para instalar o cURL no Windows acesse: https://curl.haxx.se/windows/

Vamos fazer uma request. Vamos testar um endpoint da API do GitHub, digite no console do cmd curl https://api.github.com

API Paths

A GitHub API é uma hypermedia API https://labs.bluesoft.com.br/hypermedia-apis-parte/. Você pode ver de onde vem a resposta de cada API vendo o mapa de direções. Nem todos os clientes usam esta informação, o objetivo por trás da hypermedia APIs é que o cliente pode dinamicamente ajustar seus endpoints sem gravar o código do cliente. Se o GitHub pensar em mudar sua API os clientes deverão escrever um novo endpoint, e isto é preocupante, só que não: GitHub é cuidadoso na manutenção e no suporte de sua API, um exemplo que a maioria das empresas deveriam seguir. Você pode confiar porque a referência estará dentro da API e não fora, se fosse fora facilmente ficaria desatualizado.

Estes mapas da API têm muitos dados. Por exemplo, elas não são apenas conteúdos de URLs, mas também informações de como fornecer parâmetros para as URLs. Veja a resposta da chamada que fizemos anteriormente para API do GitHub e verá que há instruções de como trabalhar com algumas URLs sem precisar recorrer a documentação. Este seria um uso ideal da hypermedia, o GitHub incorpora a documentação dentro do seu código e com certeza ela está sempre atualizada.

O Formato JavaScript Object Notation (JSON)

Toda resposta que retorna da API do GitHub irá retornar no formato JSON. JSON é um formato de dados mais “leve” (veja http://www.json.org/ ). Há outros formatos, tais como XML (Extensible Markup Language) ou YAML (YAML Ain’t Markup Language), mas o JSON vem se tornando padrão para web services.

Algumas razões do porquê o JSON é tão popular:

JSON é legível. JSON tem uma legibilidade boa para os humanos quando comparada a serialização do formato do XML.

JSON pode ser utilizada com JavaScript com poucas modificações. O formato dos dados do cliente e servidor são iguais e isto é uma fórmula vitoriosa.

Uma nota sobre o JSON é que ele só suporta aspas e não ápices (aspas simples).

Building Tools with GitHub: Customize Your Workflow (English Edition)

https://amzn.to/2T9Mivx

#git #github