API AluraFlix tem como finalidade retornar dados , no formato JSON, mediante requisições aos end point aqui listados no padrão REST. Os principais consumidores desses serviços serão aplicações front-end web ou mobile.
\nAPI publicada em: http://aluraflix.emersonmorgado.com.br:8081
\nA API faz parte do programa Aluraflix, idealizado pela Alura, destinado ao estudo e implementação de um serviço backend da plataforma de vídeo da Alura, ou seja um serviço de API REST. Têm como objetivos explorar as diversas etapas envolvidas na criação e implementação de uma API REST.\nEste projeto foi desenvolvido utilizando a linguagem Java e o framework Spring (Boot, Data, Security e Web). A camada de persistência utiliza banco de dados MariaDb / MySQL nos ambientes de dev/prod e o banco em memória H2 para os testes de integração.
\nOs principais recursos implementados são:
\nOutros recursos e o código fonte estão disponíveis no git: https://github.com/EmersonMorgado/aluraflix
\nOs serviços estão disponíveis via consultas stateless mediante o envio de token de validação. \nO token deve ser gerado pelo recurso \"/auth\" utilizando o método POST passando o\n\"email\" e \"senha\". Mais detalhes de como gerar o token estão no descrição do recurso /auth.
\nPara efeito de testes considere o email: \"alura@email.com\" e senha: \"alura\"
\nDe posse do token, o mesmo deve ser enviado no cabeçalho das requisições como \"Authorization\"
\nEmerson Morgado
\nhttps://github.com/EmersonMorgado/aluraflix
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introdução","slug":"introducao"},{"content":"Visão Geral","slug":"visao-geral"},{"content":"Autenticação","slug":"autenticacao"},{"content":"Autor","slug":"autor"}],"owner":"6125281","collectionId":"04b276d9-004d-4007-a3d2-8c28f06dd09d","publishedId":"TzsZrTiX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-07-25T01:08:10.000Z"},"item":[{"name":"/auth","event":[{"listen":"test","script":{"id":"712aae72-43a3-466c-8e4d-03c68948de23","exec":["pm.test(\"Resposta em Status 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Resposta está em JSON\"), ()=>{"," pm.response.to.be.json;","}","","pm.test('Resposta vaidação Schema', ()=> {"," var schema = {"," type: \"array\","," items:{"," type: \"object\","," required: [\"id\", \"titulo\", \"descricao\", \"url\"],"," properties:{"," id:{"," type: \"integer\""," },"," titulo:{"," type: \"string\""," },"," descricao:{"," type: \"string\""," },"," url:{"," type: \"string\""," }"," }"," }"," };"," console.info(pm.response.json())"," pm.expect(tv4.validate(pm.response.json(), schema)).to.be.true;","","});"],"type":"text/javascript"}}],"id":"96c9a972-fec4-46a7-9a5f-677da5aded8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"{{email}}\",\n \"senha\": \"{{senha}}\"\n}","options":{"raw":{"language":"json"}}},"url":"aluraflix.emersonmorgado.com.br:8081/auth","description":"Exemplo de resposta esperada:
\n{\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJBUEkgV2ViU2VydmljZSIsInN1YiI6IjEiLCJpYXQiOjE2Mjg4MjEzNjMsImV4cCI6MTYyODgyMzE2M30.bQAUPzRQPCdQL8EDAk-KWfSNGWAd8DVpavQIa61Y9_o\",\n \"type\": \"Bearer\"\n}\nEste recurso não precisa de autenticação via token. Como resposta serão listados 5 vídeos.
\nExemplo de resposta esperada:
\n {\n \"content\": [\n {\n \"id\": 3,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n },\n {\n \"id\": 4,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"sorted\": true,\n \"unsorted\": false,\n \"empty\": false\n },\n \"offset\": 2,\n \"pageNumber\": 1,\n \"pageSize\": 2,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalPages\": 2,\n \"totalElements\": 4,\n \"last\": true,\n \"number\": 1,\n \"sort\": {\n \"sorted\": true,\n \"unsorted\": false,\n \"empty\": false\n },\n \"size\": 2,\n \"numberOfElements\": 2,\n \"first\": false,\n \"empty\": false\n}\nExemplo de resposta esperada:
\n {\n \"content\": [\n {\n \"id\": 1,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n },\n {\n \"id\": 2,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n },\n {\n \"id\": 3,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n },\n {\n \"id\": 4,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"sorted\": true,\n \"unsorted\": false,\n \"empty\": false\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 5,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalPages\": 1,\n \"totalElements\": 4,\n \"last\": true,\n \"number\": 0,\n \"sort\": {\n \"sorted\": true,\n \"unsorted\": false,\n \"empty\": false\n },\n \"size\": 5,\n \"numberOfElements\": 4,\n \"first\": true,\n \"empty\": false\n}\nExemplo de resposta esperada:
\n{\n \"id\": 1,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n}\nNesta consulta é possível enviar o título do vídeo que deseja buscar. Esta busca pode ser por palavras ou sequência de caracteres existente no titulo.
\nExemplo de resposta esperada:
\n{\n {\n \"content\": [\n {\n \"id\": 1,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n },\n {\n \"id\": 2,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n },\n {\n \"id\": 3,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n },\n {\n \"id\": 4,\n \"categoriaId\": \"1\",\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n }\n ],\n \"pageable\": {\n \"sort\": {\n \"sorted\": true,\n \"unsorted\": false,\n \"empty\": false\n },\n \"offset\": 0,\n \"pageNumber\": 0,\n \"pageSize\": 5,\n \"paged\": true,\n \"unpaged\": false\n },\n \"totalPages\": 1,\n \"totalElements\": 4,\n \"last\": true,\n \"number\": 0,\n \"sort\": {\n \"sorted\": true,\n \"unsorted\": false,\n \"empty\": false\n },\n \"size\": 5,\n \"numberOfElements\": 4,\n \"first\": true,\n \"empty\": false\n}\nExemplo de resposta esperada:
\nNo head da resposta será fornecido o end point com o número do novo ID criado, (exemplo o id 33) e no corpo da resposta será enviado os dados do novo registro criado.\n Head:
\n Locatio : http://ip_servidor/videos/33\nBody
\n{\n \"id\": 33\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n} \nPara atualização do registro na API deve-se fornecer, no corpo da requisição, todos os campos preenchidos e informar, na chamada da API, o id do registro a ser atualizado.
\nExemplo de resposta esperada:
\n{\n \"titulo\": \"Titulo do Video Atualizado\",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n}\nPara remover um registro, é necessário informar o id a ser removido diretamente na chamada da requisição.
\nExemplo de resposta esperada:
\nStatus Code 200 OK, caso o registro tenha sido removido.
\nNa ocorrência de erros será informado um Status Code relacionado ao erro encontrado.
\n","urlObject":{"port":"8081","path":["videos","{{id_video}}"],"host":["aluraflix","emersonmorgado","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"6ce01e9e-faec-4444-ab1d-ae5021b88183"},{"name":"/categorias","id":"cc3425bc-160b-4471-92d2-b837e0f11121","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}],"advancedConfig":[{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"aluraflix.emersonmorgado.com.br:8081/categorias/","urlObject":{"port":"8081","path":["categorias",""],"host":["aluraflix","emersonmorgado","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"cc3425bc-160b-4471-92d2-b837e0f11121"},{"name":"/categorias/{id}","id":"5f119f90-891c-4e0d-90c7-86a98a549fbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}],"advancedConfig":[{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"aluraflix.emersonmorgado.com.br:8081/categorias/{{id_categoria}}","urlObject":{"port":"8081","path":["categorias","{{id_categoria}}"],"host":["aluraflix","emersonmorgado","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"5f119f90-891c-4e0d-90c7-86a98a549fbb"},{"name":"/categorias/{id} /videos","id":"c7436c9a-6830-401e-bc0a-06e2ef02279e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}],"advancedConfig":[{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"aluraflix.emersonmorgado.com.br:8081/categorias/{{id_categoria}}/videos","description":"End-point responsável por apresentar todos os vídeos registrados em uma categoria.
\n","urlObject":{"port":"8081","path":["categorias","{{id_categoria}}","videos"],"host":["aluraflix","emersonmorgado","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7436c9a-6830-401e-bc0a-06e2ef02279e"},{"name":"/categoria","event":[{"listen":"test","script":{"id":"569a2de6-4a17-4365-bc03-6682a62ce374","exec":["pm.test(\"Resposta em Status 201\", function () {"," pm.response.to.have.status(201);","});","","pm.test(\"Resposta está em JSON\"), ()=>{"," pm.response.to.be.json;","}","","pm.test('Resposta vaidação Schema', ()=> {"," var schema = {"," type: \"object\","," required: [\"id\", \"titulo\", \"descricao\", \"url\"],"," properties:{"," id:{"," type: \"integer\""," },"," titulo:{"," type: \"string\""," },"," descricao:{"," type: \"string\""," },"," url:{"," type: \"string\""," }"," }"," };"," console.info(pm.response.json())"," pm.expect(tv4.validate(pm.response.json(), schema)).to.be.true;","","});"],"type":"text/javascript"}}],"id":"e6d8126d-0079-4665-8c26-f11e4b4e7af9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}],"advancedConfig":[{"key":"password","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" {\n \"titulo\": \"{{tituloCategoria}}}\",\n \"cor\": \"{{corCategoria}}\"\n }"},"url":"aluraflix.emersonmorgado.com.br:8081/categorias/","description":"Exemplo de resposta esperada:
\nNo head da resposta será fornecido o end point com o número do novo ID criado, (exemplo o id 33) e no corpo da resposta será enviado os dados do novo registro criado.\n Head:
\n Locatio : http://ip_servidor/videos/33\nBody
\n{\n \"id\": 33\n \"titulo\": \"Titulo do Video \",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n} \nPara atualização do registro na API deve-se fornecer, no corpo da requisição, todos os campos preenchidos e informar, na chamada da API, o id do registro a ser atualizado.
\nExemplo de resposta esperada:
\n{\n \"titulo\": \"Titulo do Video Atualizado\",\n \"descricao\": \"Descrição do video \",\n \"url\": \"https://www.link_do_video.com.br\"\n}\nPara remover um registro, é necessário informar o id a ser removido diretamente na chamada da requisição.
\nExemplo de resposta esperada:
\nStatus Code 200 OK, caso o registro tenha sido removido.
\nNa ocorrência de erros será informado um Status Code relacionado ao erro encontrado.
\n","urlObject":{"port":"8081","path":["categorias","{{id_categoria}}"],"host":["aluraflix","emersonmorgado","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"108f8b55-a884-441e-9df3-a4349859abcf"}]}