No artigo, apresentarei como criar uma API de forma rápida e fácil usando Symfony e o API plataforma. Esta biblioteca fornece CRUD, paginação, validação e documentação totalmente funcional e permite o uso de GraphQL. Abaixo vou mostrar como funciona a plataforma API usando um aplicação simples exemplo.
Guia para plataforma API
Instalação
A maneira mais fácil de começar a trabalhar com a plataforma API é baixar um pacote pronto do GitHub. Ele contém todos os componentes necessários para criar seu primeiro projeto. Depois de descompactar o conteúdo e executá-lo com docker-compose up, o ambiente de desenvolvimento completo será iniciado.
- php contêiner com PHP 7.2 e compositor
- contêiner db com banco de dados PostgreSQL
- Cliente um contêiner com o parte front-end do aplicativo contém uma página de boas-vindas por padrão
- Contêiner proxy de cache com proxy para API
- h2-proxy http/2 e https para todos os aplicativos, deve ser usado apenas para fins de desenvolvimento.
Modelo
Começaremos criando classes para representar cada um dos elementos do aplicativo. Em seguida, mapeamos essas classes para o banco de dados e usamos a anotação fornecida pelo Doctrine ORM. Consistirá em informações básicas do usuário: nome e email. Portanto, vale a pena certificar-se de que o modelo implemente a interface do usuário e contenha todos os campos necessários.
CRUD
É necessário informar à biblioteca da plataforma API quais modelos devem ser considerados como elementos da API. É possível fazer isso usando XML, yaml ou anotação. Decidi usar o último método.
Grupos de serialização
Eles exigem informações precisas sobre os campos que serão inseridos e apresentados. Enquanto a normalização, a desnormalização, Plataforma API usa symfony, serializador. Você pode usar isso para alterar a forma de apresentação dos objetos.
Validação
O aplicativo começará a tomar forma. Se você inserir valores incorretos ao criar novos registros a aplicação retornará um erro ao invés de nos informar que o valor está incorreto.
Configuração de ações disponíveis
A plataforma API nos permite gerenciar os endpoints disponíveis de forma simples. Eles são agrupados em dois tipos de operações. O primeiro grupo refere-se às operações realizadas sobre uma coleção de objetos ou à criação de um novo elemento. Um tipo diferente de operação está sempre relacionado a um determinado elemento e este elemento deve ser marcado.
Links incorporados
A API deve permitir que o usuário obtenha lições que pertencem a um determinado assunto e flashcards que pertencem a uma lição específica. O Plataforma API permite a preparação rápida de endpoints que vêm com os dados necessários.
Conclusão
Abordei como criar uma API e mostrei algumas das funcionalidades básicas da API. No aplicativo é possível criar novos cartões, aulas, disciplinas e novos usuários.
