Criou página com '=1.Objetivos= <br> Entender o conceito de APIs REST e como aplicá-las no padrão Open Gateway para Network APIs. <br> =2.Definições e Conceitos Importantes= <br> *REST: A...' |
|||
| Linha 15: | Linha 15: | ||
=3.Material Utilizado= | =3.Material Utilizado= | ||
<br> | <br> | ||
*Artigos: Introdução a APIs | *Artigos: [[ https://www.dio.me/articles/introducao-as-apis-conceitos-implementacao-e-boas-praticas | Introdução a APIs: Conceitos, Implementação e Boas Práticas ]] | ||
*Cursos: Curso Alura - | *Cursos: [[ https://www.alura.com.br/curso-online-node-js-api-rest-express-mongodb?srsltid=AfmBOopp-Wbp_vjQM9M69T9AfVN8WseR5QkFW5l8sjNO1qpLCMAqSVG5 | Curso Alura - Node.js: criando uma API Rest com Express e MongoDB ]] | ||
*Documentação: Open Gateway - Especificações | *Documentação: [[ https://developers.opengateway.telefonica.com/reference/phonenumberverify | Open Gateway - Especificações ]] | ||
*[[ https://github.com/camaraproject/NumberVerification | GitHub - Number Verification]] | |||
<br> | <br> | ||
Edição das 13h02min de 5 de dezembro de 2024
1.Objetivos
Entender o conceito de APIs REST e como aplicá-las no padrão Open Gateway para Network APIs.
2.Definições e Conceitos Importantes
- REST: Arquitetura que utiliza padrões HTTP para comunicação entre sistemas.
- Endpoints: Pontos de acesso às funcionalidades da API.
- Métodos HTTP: GET, POST, PUT, DELETE, etc.
3.Material Utilizado
- Artigos: [[ https://www.dio.me/articles/introducao-as-apis-conceitos-implementacao-e-boas-praticas | Introdução a APIs: Conceitos, Implementação e Boas Práticas ]]
- Cursos: [[ https://www.alura.com.br/curso-online-node-js-api-rest-express-mongodb?srsltid=AfmBOopp-Wbp_vjQM9M69T9AfVN8WseR5QkFW5l8sjNO1qpLCMAqSVG5 | Curso Alura - Node.js: criando uma API Rest com Express e MongoDB ]]
- Documentação: [[ https://developers.opengateway.telefonica.com/reference/phonenumberverify | Open Gateway - Especificações ]]
- [[ https://github.com/camaraproject/NumberVerification | GitHub - Number Verification]]
4.Aprendizados e Insights
4.1. Realizações Práticas
(Use esta seção para registrar o que foi feito de forma objetiva, destacando as ferramentas ou padrões utilizados)
Desenvolvi a API Number Verification seguindo o padrão Open Gateway, utilizando Java e o framework Spring. Implementação incluiu:
- Endpoints RESTful para validação de números.
- Configuração de autenticação básica.
- Documentação da API com Swagger.
4.2. Aprendizados Técnicos (Descreva o que foi aprendido de forma reflexiva, destacando os pontos mais relevantes para o seu desenvolvimento ou para a equipe:)
- Compreendi como estruturar uma API no padrão REST com boas práticas, como:
- Uso adequado de métodos HTTP (GET, POST, etc.).
- Configuração de respostas com códigos de status padrão (200 OK, 404 Not Found).
- Aprendi a utilizar o Spring Boot para simplificar a configuração do servidor.
- Apliquei o conceito de separação de responsabilidades, usando controllers, services e repositories.
4.3. Desafios e Soluções (Registre os desafios encontrados e as soluções aplicadas. Isso ajuda a consolidar o aprendizado e pode ser útil para outros membros da equipe)
- Desafio: Configurar autenticação segura na API.
- Solução: Integrei o Spring Security para autenticação com tokens JWT.
- Desafio: Lidar com erros de validação nos inputs dos usuários.
- Solução: Configurei o tratamento de exceções com handlers personalizados.
4.4. Aplicações Futuras (Use esta seção para registrar como o aprendizado pode ser aplicado em outros projetos ou áreas)
- Este padrão de API será replicado em outros serviços que precisam de integração com Network APIs.
- O uso de JWT pode ser explorado em APIs internas da empresa para autenticação.