Skip to main content

Guides

Saiba mais sobre como começar com a API REST, sobre a autenticação e como usar a API REST para várias tarefas.

Esta seção da documentação tem o objetivo de ajudar você a executar os aplicativos de API do mundo real do GitHub. Abordaremos tudo o que você precisa saber, desde autenticação até manipulação e integração de resultados com outros aplicativos. Cada tutorial incluirá um projeto, e cada projeto será salvo e documentado em nosso repositório de amostras de plataforma pública.

Scripts com a API REST e o JavaScript

Escreva um script usando o SDK do Octokit.js para interagir com a API REST.

Scripts com a API REST e o Ruby

Saiba como escrever um script usando o SDK do Octokit.rb para interagir com a API REST.

Descobrir recursos para um usuário

Saiba como encontrar os repositórios e organizações que o seu aplicativo pode acessar para um usuário de forma confiável para as suas solicitações autenticadas para a API REST.

Entregar implantações

Ao usar a API RESt de implantações, você pode criar ferramentas personalizadas que interagem com seu servidor e um aplicativo de terceiros.

Representar dados como gráficos

Aprenda a visualizar as linguagens de programação do seu repositório usando a biblioteca D3.js e o Ruby Octokit.

Trabalhar com comentários

Ao usar a API REST, você pode acessar e gerenciar comentários nos seus pull requests, problemas ou commits.

Criar um servidor de CI

Crie o seu próprio sistema CI usando a API de status.

Como usar a API REST para interagir com seu banco de dados Git

Use a API REST para ler e gravar objetos Git brutos em seu banco de dados Git em GitHub e para listar e atualizar suas referências (marcas e cabeçalhos de ramificação).

Como usar a API REST para interagir com verificações

Use a API REST para criar GitHub Apps que executam verificações avançadas em alterações de código em um repositório. Você pode criar os aplicativos que realizam integração contínua, linting ou serviços de varredura de código e fornecem feedback detalhado sobre commits.

Criptografando segredos para a API REST

Para criar ou atualizar um segredo com a API REST, você deve criptografar o valor desse segredo.