O que é a API REST do WordPress e como você a usa?

Publicados: 2022-06-30

Você provavelmente já ouviu falar da API REST. Talvez você já tenha ouvido falar que os usuários do WordPress se beneficiam disso. Mas você também pode estar se perguntando o que é exatamente uma API do WordPress.

Entender como as APIs funcionam não é tão complicado quanto parece. Continue lendo para saber o que é uma API, o que é API REST e como você pode usar a API REST do WordPress em seus sites.

O que é uma API?

Uma interface de programação de aplicativos (API) é uma maneira de dois aplicativos “conversarem” entre si. Um sistema faz uma solicitação e o outro a atende. As solicitações que um sistema aceita devem ser incluídas na API — caso contrário, a solicitação não poderá ser atendida.

Pense nisso desta maneira. Talvez você esteja com muita fome, então você vai para a Waffle House. Você pede café, ovos e panquecas. A garçonete começa a anotar seu pedido – e então fica confusa quando você chega às panquecas. A Waffle House não serve panquecas. Eles só servem waffles.

Um sistema solicitando panquecas de um menu de API que serve apenas waffles ficará faminto.

O que é a API REST?

Quando dizemos API REST, estamos falando de um sistema de restrições projetado para a internet. Ele descreve como um site pode solicitar informações de outro site de forma escalável e uniforme. REST significa Representational State Transfer, que foi definido por Roy Fielding em sua tese de doutorado.

O que é a API REST do WordPress?

A API REST do WordPress refere-se a solicitações feitas a um site executado no WordPress. Se solicitarmos uma lista de postagens ou páginas, podemos esperar receber essas informações da API REST do WordPress. O WordPress nunca fornecerá nenhuma informação que não seja pública, como rascunhos de postagens ou (mais importante) senhas de usuários.

Isso é fundamental para o Block Editor, que troca dados dinamicamente com o WordPress sem recarregar a página. Cada endpoint retorna dados em um formato JSON que pode ser lido por JavaScript — ou, neste caso, blocos.

Observe que a API REST é apenas uma das APIs fornecidas pelo WordPress. Há também, por exemplo, a API de banco de dados e a API de metadados, que são usadas por plugins para interagir com o WordPress no servidor. Você pode aprender mais sobre as APIs do WordPress no Codex.

Como funciona uma solicitação de API REST do WordPress?

Existem algumas partes básicas da API REST, a saber: rotas, endpoints, solicitações e respostas.

Rotas

Uma rota é como referenciamos a URL pela qual o site se comunica. Uma rota comum no WordPress é “/wp-admin”. Embora não seja uma rota da API REST, é uma rota utilizada pelo navegador para acessar o Painel de Administração do WordPress. Para nossos propósitos, as rotas da API REST começam com “/wp-json” (sendo JSON o formato padrão dos dados).

Pontos de extremidade

Um endpoint é a combinação de uma rota e o tipo de solicitação de entrada. Uma única rota pode se conectar a vários endpoints, pois há vários tipos de solicitação. Tipos de solicitação comuns incluem GET (como lemos dados em uma rota) e POST (como atualizamos dados em uma rota).

Solicitações e respostas

Cada comunicação com a API REST é intercalada entre uma solicitação e uma resposta. Um sistema faz uma solicitação à qual o outro sistema responde. A API REST do WordPress inclui objetos úteis para plugins acessarem os dados de solicitação (WP_REST_Request) e gerenciarem os dados de resposta (WP_REST_Response) ao estender a API REST do WordPress.

Como instalar a API REST no WordPress

A partir da versão 4.7 do WordPress, o WordPress inclui a API REST como recurso principal.

Se você estiver executando uma versão mais antiga, poderá instalar o plug-in de recurso json-rest-api. Isso foi usado para desenvolver a API REST antes de ser totalmente integrada à base de código do WordPress. Este plugin é tecnicamente fechado, por isso é recomendável atualizar sua versão do WordPress (ou talvez considere a Hospedagem Gerenciada do WordPress e você estará sempre atualizado.)

Exemplos de API REST do WordPress

Dê uma olhada no site da GiveWP. Se você for ao blog deles, poderá ver notícias e postagens recentes. Essa rota renderiza HTML, o que é bom de se ver, mas difícil para um programador interagir. Em vez disso, as postagens são disponibilizadas aos programadores usando a rota “/wp-json/wp/v2/posts”.

A rota “/wp-json/wp/v2/posts” nos diz que este é um recurso do WordPress (“/wp”), que esta é a versão 2 (“/v2/”) do recurso e, especificamente, que estes são mensagens (“/posts”). Se você ainda não o fez, visite https://givewp.com/wp-json/wp/v2/posts e compare o que você vê com https://givewp.com/blog/. Vou lhe dar uma dica - é a mesma informação!

Para um exemplo de como a API REST é usada no WordPress, considere o bloco de postagens mais recentes. Para obter uma lista de postagens no WordPress, o site tradicionalmente precisa fazer uma solicitação ao servidor e renderizar novamente a página inteira.

O bloco de postagens mais recentes pode solicitar apenas as postagens e, em seguida, renderizar-se novamente. Ele faz isso usando a API REST. E pode fazer isso várias vezes para pesquisar novas postagens - sem renderizar novamente a página inteira. Isso é especialmente útil quando você considera a edição completa do site em que os blocos são usados ​​para editar e exibir os componentes da página.

Cada componente individual pode solicitar os dados de que precisa (incluindo a verificação de atualizações) e, em seguida, renderizar novamente apenas o que foi alterado.

Agora você sabe

Agora que você conhece o propósito e a estrutura de uma API REST do WordPress, dê uma olhada para ver o que pode encontrar por conta própria. Para um resumo completo sobre como usar e estender a API REST do WordPress, confira o Manual da API REST.

Lembre-se: se alguém perguntar sobre APIs, você não pode pedir panquecas na Waffle House.

Enquanto você ajusta seu site, não se esqueça de que ótimos sites precisam de ótima hospedagem. Você obtém tudo isso com o Managed WordPress da Nexcess. Com velocidades poderosas, opções de escalabilidade e suporte excepcional, você pode confiar no Nexcess para alimentar seu site WordPress.

Venha ver por que o melhor é integrado com o Nexcess. Confira nossos planos de hospedagem totalmente gerenciados do WordPress hoje.

Explore os planos de hospedagem do WordPress

Recursos WordPress Relacionados

  • WordPress.com vs WordPress.org
  • 5 técnicas avançadas para acelerar seu site WordPress
  • O que é Hospedagem WordPress?
  • O guia essencial para plugins do WordPress
  • Como escolher um host: o que procurar e o que evitar