Analisando código com a API de detecção de código

O mundo funciona em código. Quase todos os aspectos de nossas vidas são de alguma forma, forma ou forma manipulados por código. Pode estar escondido e funcionando nos bastidores, mas está sempre presente em nossas atividades diárias. Acordar de manhã graças ao nosso despertador ou aplicativo de telefone, consumir notícias e mídia em um dispositivo inteligente ou TV, pedir comida para jantar, levar ou entregar, ou até mesmo navegar no trânsito para ir do ponto A ao ponto O código B é a força motriz por trás de tudo.

Como tal, o código que executa o mundo cresceu exponencialmente, e continua a crescer diariamente, à medida que mais aplicativos e serviços pretendem permear nossas vidas. A maior parte desse código não existe no computador de apenas uma pessoa. Ele está sendo escrito, compartilhado e discutido por equipes de pessoas, e as ferramentas usadas para compartilhar e discutir esse código não conseguem acompanhar.

Mas não é apenas um problema de “equipes”. Você já encontrou trechos de código em sites que não são rotulados ou classificados? Claro que você tem. Nós todos temos!

Os desenvolvedores precisam de ferramentas para ajudar a detectar, rotular, formatar e enriquecer seu código, e a API de detecção de código foi criada para esse propósito explícito.

O que é a API de detecção de código?

A API de detecção de código é um processador de código construído como um esforço conjunto da Runtime e da APILayer. O foco do Runtime é ser pioneiro na detecção, processamento, rotulagem, enriquecimento e transformação de código – também conhecido como Processamento de Linguagem Técnica. Eles são responsáveis ​​pelo aplicativo Pieces que pode salvar instantaneamente trechos de código, extrair código de capturas de tela e autocompletar código de energia desses trechos. O APILayer não apenas cria APIs RESTful escaláveis ​​e de alto desempenho, mas também cria a infraestrutura quase sempre ativa em que essas APIs são executadas.

A API de detecção de código é simples de usar e pode determinar se uma string fornecida é linguagem natural ou linguagem técnica (ou seja, código). Se detectar código, ele identifica o idioma com um alto nível de precisão. A melhor parte é a velocidade da API de detecção de código; leva apenas aproximadamente 250 ms para analisar e identificar a entrada fornecida. Não só é extremamente rápido, mas minimiza os recursos de computação no dispositivo.

Portanto, não importa qual software você esteja construindo, seja um site de documentação, fórum, editor de código online ou uma ferramenta focada no desenvolvedor, você precisa da API de detecção de código.

Por que usar a API de detecção de código?

A API de detecção de código é uma API fácil de usar que detecta, processa, rotula, enriquece e transforma o código, e você não encontrará nenhum outro serviço ou solução que possa fornecer todos esses recursos:

Detecção rápida de código

A API de detecção de código determina se uma string de texto fornecida inclui um snippet de código usando os modelos de aprendizado de máquina do Runtime.

Classificação precisa

Existem muitas linguagens técnicas, e a API de detecção de código detecta com precisão 30 linguagens, incluindo JavaScript, PHP, C#, Ruby, Go, HTML, Markdown, C e C++.

Enriquecer e transformar snippets

A API de detecção de código pode gerar versões truncadas e com destaque de sintaxe do seu código.

Melhore o SEO

Use a API de detecção de código para classificar os snippets de código do seu site e use os metadados gerados para melhorar a indexação, o que aumentará a visibilidade do seu site.

Altamente escalável

A API de detecção de código é executada na infraestrutura de nuvem do APILayer e pode atender às suas demandas menores e maiores.

Velocidade incomparável

O processador de linguagem técnica do Runtime analisa o código em milissegundos e o APILayer fornece a resposta por meio de sua infraestrutura ultrarrápida.

Quase 100% de tempo de atividade

Embora nada seja 100%, os tempos de atividade dos serviços da APILayer são os mais próximos possíveis.

Como funciona

É fácil começar a usar a API de detecção de código. Primeiro, você precisa criar uma conta Runtime.dev. Depois de verificar seu endereço de e-mail e fazer login, você entrará no Runtime Developer Console.

Você precisa de uma chave de API para usar a API de detecção de código e, embora tecnicamente possa recuperar uma gratuitamente (para uma avaliação de 14 dias), deve fornecer um cartão de crédito para iniciar a avaliação. Para obter uma chave, clique no botão Descubra produtos botão no Runtime Developer Console, selecione o plano desejado e insira suas informações de pagamento.

Após iniciar sua avaliação, você será redirecionado de volta para o Console do desenvolvedor de tempo de execuçãoonde você encontrará sua chave de API (e segredo), bem como um exemplo de solicitação usando cURL e sua resposta.

Tutorial rápido

Vamos usar a API de detecção de código para avaliar algum texto arbitrário. É importante observar, no entanto, que a API de detecção de código não suporta CORS no momento da redação deste artigo. Portanto, você não pode enviar solicitações diretamente usando JavaScript de dentro do navegador. Portanto, os exemplos de código a seguir usarão PHP e a biblioteca HTTP Guzzle. Nota: a biblioteca Guzzle não é necessária; você pode obter os mesmos resultados com funções cURL.

Primeiro, crie um objeto cliente HTTP Guzzle chamando o Client() construtor:

$client = new GuzzleHttpClient();

O próximo passo é enviar um POST solicitação para a API de detecção de código. O pedido deve incluir o apiKey Parâmetro de URL definido para sua chave de API e o corpo da solicitação deve estar no formato JSON, conforme mostrado no código a seguir:

$response = $client->request('POST', 'https://api.runtime.dev/tlp?apikey=your_api_key', [
    'json' => [
        'iterable' => [
            ['value' => '$my_obj->method();']
        ]
    ]
]);

Este código usa o objeto cliente request() e passa três argumentos. O primeiro argumento é o método HTTP, o segundo é o URL para o qual enviar a solicitação e o terceiro é uma matriz que especifica o corpo da solicitação. Para enviar JSON, a chave da matriz do corpo deve ser a string jsone seu valor é um objeto ou array que pode ser serializado na seguinte estrutura:

{
  "iterable": [
    { "value": "text to process" }
  ]
}

o iterable propriedade é uma matriz de entradas. Cada entrada é um objeto que tem um value e seu valor é o texto que a API de detecção de código deve avaliar. Você deve incluir pelo menos uma entrada com a solicitação.

A API responde com uma carga JSON. Aqui está a resposta truncada da solicitação acima:

Assim como a requisição, a resposta tem uma propriedade chamada iterable, e é um array que contém a análise do resultado das entradas solicitadas. Como seria de esperar, os índices da resposta iterable array corresponde diretamente com os índices na solicitação iterable variedade.

Cada resultado tem naturalLanguage e codeClassification propriedades, cada uma das quais é um objeto que tem uma result propriedade. o naturalLanguage do objeto result A propriedade informa se a entrada fornecida é texto natural. o result por codeClassification fornece uma variedade de informações se a entrada fornecida for um código.

Falando em código, vamos voltar a ele. Naturalmente, você precisa decodificar a resposta JSON em objetos:

$data = json_decode($response->getBody());
$data->iterable[0]->naturalLanguage->result; // false in this case
$data->iterable[0]->codeClassification->result->current; // the language of the input; PHP in this case 
$data->iterable[0]->codeClassification->result->likelihood; // percentage of surety the input is the current’s language

Preços

A API de detecção de código tem três planos de assinatura. Cada plano concede a você créditos de API e vários recursos. Obviamente, as assinaturas de nível superior concedem mais créditos de API e fornecem recursos extras.

Não há plano gratuito; no entanto, você obtém uma avaliação gratuita de 14 dias, independentemente da assinatura escolhida. Você precisa fornecer um cartão de crédito para iniciar o teste. Os três planos são:

Conclusão

O código que os desenvolvedores devem enfrentar continua a crescer exponencialmente. Se você ou sua equipe estão escrevendo software que permite que os desenvolvedores visualizem, compartilhem e discutam o código, você precisa integrar a API de detecção de código em seus aplicativos. Começar é rápido e fácil. Então comece hoje mesmo!