Content text Desenvolvimento de APIs.pdf
DESENVOLVIMENTO DE APIs
Desenvolvimento de APIs - Desafio 1 Desenvolvimento de APIs 2 | SENAI SUMÁRIO PARA COMEÇAR.................................................................................................................................. 3 SITUAÇÃO-PROBLEMA..................................................................................................................... 3 DESAFIO 1.............................................................................................................................................. 4 PRÉ-REQUISITO E ROTEIRO DE CONFIGURAÇÃO.................................................................. 6 MÉTODOS DE REQUISIÇÃO HTTP................................................................................................ 7 API...........................................................................................................................................................11 REST (TRANSFERÊNCIA REPRESENTACIONAL DE ESTADO) ............................................12 JSON E XML.........................................................................................................................................13 RESTFUL ...............................................................................................................................................14 DESENVOLVENDO UMA API.........................................................................................................16 DOCUMENTAÇÃO DO SISTEMA..................................................................................................18 NESTE DESAFIO.................................................................................................................................19 DESAFIO 2............................................................................................................................................20 INTRODUÇÃO.....................................................................................................................................21 CONTROLANDO O ACESSO..........................................................................................................22 DEPURAÇÃO.......................................................................................................................................26 TRATAMENTO DE EXCEÇÕES .......................................................................................................27 METODOLOGIAS ÁGEIS PARA DESENVOLVIMENTO DE APIS .........................................28 NESTE DESAFIO.................................................................................................................................37 PARA CONCLUIR................................................................................................................................37 REFERÊNCIAS .....................................................................................................................................38 CRÉDITOS.............................................................................................................................................39 MATERIAL COMPLEMENTAR .......................................................................................................40
Desenvolvimento de APIs - Desafio 1 Desenvolvimento de APIs 3 | SENAI PARA COMEÇAR Este material aborda conceitos relacionados a Desenvolvimento de APIs. Esperamos que você desenvolva, no decorrer de seus estudos, as seguintes capacidades: • Desenvolver a API do aplicativo, disponibilizando os recursos para leitura, escrita, atualização e deleção do projeto. • Restringir o acesso aos recursos da API aos usuários autenticados, visando a integridade e segurança da informação. Para desenvolver tais capacidades, você deverá estudar os seguintes temas: • Métodos de requisição HTTP. • Padrão Model View Control (MVC). • API. • Linguagem de programação para APIs. O estudo desses temas será necessário para que você resolva a situação-problema a seguir. Então, avance para conhecê-la. SITUAÇÃO-PROBLEMA A ExoApi é uma empresa de desenvolvimento de software focada na integração entre diferentes sistemas, softwares ou serviços. Utiliza as tecnologias mais recentes do mercado para ter performance, controle, segurança e escalabilidade para sua empresa e seus contratantes. A ExoApi contratou você para desenvolver a nova demanda que será realizada para o lançamento de seu novo aplicativo. O aplicativo consiste em armazenar todos os projetos que a empresa realiza para ter maior controle e melhorar a gestão e visibilidade do que está sendo feito por seus funcionários. Essa demanda consiste em desenvolver a interface (API) para disponibilizar os dados que serão apresentados e utilizados pela equipe de mobile e exige os seguintes critérios:
Desenvolvimento de APIs - Desafio 1 Desenvolvimento de APIs 4 | SENAI • Ler todos os projetos (título, status, data de início, tecnologias/requisitos/ área); • Buscar informações somente de um projeto; • Deletar um projeto; • Atualizar todas as informações de um projeto ou somente uma informação específica; • Disponibilizar a documentação da API; • Retornar os status de respostas corretos de acordo com as melhores práticas; • Retornar os dados em formato JSON; • Utilizar frameworks para a criação de API; • Disponibilizar o recurso de deletar um projeto, somente para usuários que possuem permissão; Para concluir esse projeto, você deverá solucionar os seguintes desafios. Desafio 1 Desenvolver a API do aplicativo, disponibilizando os recursos para leitura, escrita, atualização e deleção do projeto. Desafio 2 Restringir o acesso aos recursos da API aos usuários autenticados, visando a integridade e segurança da informação. DESAFIO 1 Nesta etapa, você deverá resolver o desafio 1: • Desenvolver a API do aplicativo, disponibilizando os recursos para leitura, escrita, atualização e deleção do projeto. Para isso, você estudará os seguintes conteúdos: