<p>O <a href="https://github.com/curl/curl">CURL</a> é uma ferramenta de linha de comando que permite transmitir dados com sintaxe de URL, suportando uma miríade de protocolos (DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS e WSS). Neste artigo, vou focar no uso do CURL para fazer requisicões HTTP para APIs, que, pelo menos, para mim, é o uso mais comum.</p>
<h2>Instalação</h2>
<p>O CURL já vem instalado na maioria das distribuições Linux e nas versões <a href="https://techcommunity.microsoft.com/t5/containers/tar-and-curl-come-to-windows/ba-p/382409">mais recentes do Windows</a>. Para verificar se ele está instalado, basta executar o comando <code>curl</code> no terminal. Se você não tiver o CURL instalado, você pode instalar com o comando <code>sudo apt install curl</code> (Ubuntu/Debian) ou <code>sudo yum install curl</code> (CentOS/Fedora) ou <code>winget install curl</code> (Windows).</p>
<p>Ah, e como é comum que trabalhemos com APIs REST no desenvolvimento web, outra ferramenta de linha de comando que nos será útil é a <a href="https://jqlang.github.io/jq/"><code>jq</code></a>, que serve para formatar o JSON no terminal. Para instalar a <code>jq</code>, basta executar o comando <code>sudo apt install jq</code> (Ubuntu/Debian) ou <code>sudo yum install jq</code> (CentOS/Fedora) ou <code>winget install jqlang.jq</code> (Windows).</p>
<h2>Nossa API de exemplo</h2>
<p>Para fins didáticos, vou usar o <a href="https://dummyjson.com/">DummyJSON</a> como API.</p>
<h2>Fazendo uma requisição GET</h2>
<p>Para fazer uma requisição GET, basta executar o comando <code>curl</code> seguido da URL que você quer acessar. Por exemplo, para solicitar os dados do produto 1, basta executar o comando <code>curl https://dummyjson.com/products/1</code>.</p>
<p>E, para formatar a saída, basta adiciona um <code>| jq</code> ao final do comando:</p>
<pre><code class="highlited-code-wrapper langbash"><div class="highlited-code" data-language="bash">curl https://dummyjson.com/products/1 | jq</div>
</code></pre><h2>Fazendo uma requisição POST,  PUT,  PATCH ou DELETE com JSON no corpo</h2>
<p>Para fazer uma requisição POST, basta executar:</p>
<pre><code class="highlited-code-wrapper langbash"><div class="highlited-code" data-language="bash">curl --json '{&quot;title&quot;: &quot;Novo produto&quot;}' https://dummyjson.com/products/add</div>
</code></pre><p> O <code>curl</code> se encarregará de adicionar os cabeçalhos <code>Content-Type: application/json</code> e <code>Accept: application/json</code>. Caso queira fazer uma requisição do tipo <code>PUT</code>, <code>PATCH</code> ou <code>DELETE</code>, adicione a opção <code>-X</code> seguida do método HTTP que você quer usar. Por exemplo, para fazer um <code>PUT</code>, execute:</p>
<pre><code class="highlited-code-wrapper langbash"><div class="highlited-code" data-language="bash">curl -X PUT --json '{&quot;title&quot;: &quot;Novo título&quot;}' https://dummyjson.com/products/1</div>
</code></pre><p>Você também pode enviar um arquivo JSON ao invés de digitar o JSON no terminal colocando um <code>@</code> na frente do nome do arquivo:</p>
<pre><code class="highlited-code-wrapper langbash"><div class="highlited-code" data-language="bash">curl --json @arquivo.json https://dummyjson.com/products/add</div>
</code></pre><p>Ou passando os dados do <a href="https://man.archlinux.org/man/stdin.3.en"><em>stdin</em></a> (note que eu uso <code>@-</code> ao invés de <code>@</code> para indicar que os dados virão do <em>stdin</em>):</p>
<pre><code class="highlited-code-wrapper langbash"><div class="highlited-code" data-language="bash">curl --json @- https://dummyjson.com/products/add &lt; arquivo.json</div>
</code></pre><h2>Fazendo uma requisição com cabeçalhos</h2>
<p>Para fazer uma requisição com cabeçalhos, basta executar o comando <code>curl</code> seguido da URL que você quer acessar, e da opção <code>-H</code> seguida do cabeçalho que você quer enviar. Então, para enviar um Bearer Token, você executaria o seguinte comando:</p>
<pre><code class="highlited-code-wrapper langbash"><div class="highlited-code" data-language="bash">curl -H &quot;Authentication: Bearer token&quot; --json '{&quot;title&quot;: &quot;Novo produto&quot;}' https://dummyjson.com/products/add</div>
</code></pre><h2>Alguns exercícios</h2>
<p>Julia Evans publicou alguns exercícios para você ficar fluente no uso do curl. Vale a pena dar uma olhada <a href="https://jvns.ca/blog/2019/08/27/curl-exercises/">neste artigo</a> no blog dela.</p>
<h2>Referências</h2>
<ul>
<li><a href="https://manpages.ubuntu.com/manpages/lunar/en/man1/curl.1.html">curl manpage</a></li>
</ul>


Douglas Moura

Douglas Moura

#curl

O mínimo que você precisa saber para testar suas APIs com CURL