Eu desenvolvo APIs há vários anos e elas têm se tornado cada vez mais comum na vida dos desenvolvedores server-side graças a ascensão dos frameworks JavaScript, aplicativos móveis e arquiteturas centradas em APIs. Por um lado você apenas captura os dados de uma fonte e os repassa como JSON, mas sobreviver às mudanças na lógica de programação, atualizações no esquema do banco de dados, novidades e deprecações pode rapidamente complicar as coisas.

Descobri que a maioria dos recursos disponíveis são incompletos ou voltados unicamente para um framework. Muitos livro e tutoriais usam maçãs e peras como exemplos, que não são concretos o suficiente, ou falam como se listar "/users" e "users/1" fossem os únicos pontos de destinos que você precisará acessar em uma API. Neste último ano eu trabalhei em uma empresa chamada Kapture, onde minha principal função foi herdar, refazer, manter e desenvolver uma API com diversos pontos de destino expondo uma grande quantidade de casos de uso.

A API em questão estava em sua versão 2 e usava o framework FuelPHP quando entrei na empresa. Ela utilizava um ORM que já foi descontinuado por seu desenvolvedor original. A Kapture estava no processo de refazer sua aplicação para iPhone para implementar novas funções. Eu aproveitei a oportunidade para acabar com essa bagunça e desenvolver a versão 3 usando o Laravel 4, tirando vantagem do seu Roteador, Migração de Banco de Dados, Esquema, Semeador, etc. Agora estamos fazendo o mesmo com a versão 4, mas desta vez não foi preciso reescrever nada; embora algumas funcionalidades sejam diferentes, o repositório da versão 3 foi forcado para a versão 4 e ambas estão sendo mantidas e rodam lado-a-lado nos mesmos servidores de API.

Com as boas práticas e conselhos gerais compartilhados neste livro, você que é novo no desenvolvimento de API terá uma boa base para começar. Do outro lado, ao relatar algumas histórias horripilantes (e como elas foram superadas ou evitadas) espero ajudá-lo a evitar as mesmas armadilhas em que eu caí, quase caí ou presenciei outros caírem. Este livro falará sobre a teoria do planejamento e desenvolvimento de APIs em qualquer linguagem de programação ou framework. Estas teorias serão aplicadas em exemplos em PHP. Evitarei código em excesso para que você não durma e também para manter os programadores de outras linguagens contentes.

Alguns do assuntos mais avançados cobertos neste livro incluem: testando pontos de destino, incorporando dados de objetos de um modo consistente e escalável, paginando respostas (incluindo objetos incorporados) e links HATEOAS.

Próximos Capítulos

• Documentação
• HATEOAS
• Versionamento de APIs