Search by 
bobfreitass / coffee
There is no license information available for the latest version (1.0.1) of this package.
API para incluir, consultar, apagar e editar uma lista de cafés.
1.0.1
2020-07-03 14:17 UTC
This package is not auto-updated.
Last update: 2024-09-22 09:08:44 UTC
README
<!doctype html> <html> <head> <meta charset="utf-8"> <title>Documento sem título</title> </head> <body> <p><strong style="font-size: 24px">API – Coffee v1.0: Desenvolvida para cadastra, listar e apagar variedades de café.</strong></p> <p> </p> <p><strong>REQUISITOS PARA UTILIZAÇÃO:</strong></p> <ul type="disc"> <li>PHP (recomendado versao7.2 ou superior)</li> <li>MySQL (recomendado versão 5.7 ou superior)</li> <li>POSTMAN (utilizado para estar a API). Clique <a href="https://www.getpostman.com/apps">Aqui</a> para baixar.</li> <li>COMPOSER (Recomendado para instalar a API). Clique <a href="https://getcomposer.org/download/">Aqui</a> para baixar.</li> </ul> <blockquote> <p><strong>IMPORTANTE:</strong> <br> Para demonstrar a <strong>API</strong>, iremos utilizar o servidor web APACHE.<br> Para SERVIDORES ambientado em Windows, é necessário que o PHP esteja declarado na variável de ambiente PATH, pois iremos utilizar comandos PHP em Prompt de Comando. <a href="https://getcomposer.org/doc/00-intro.md">Veja como fazer!</a></p> <p> </p> </blockquote> <p><strong>INSTALANDO A API:</strong></p> <ol> <li>Crie uma pasta para a API em seu servidor.</li> <li> Abra o Promp de Comando e vá até o diretório criado.</li> <li> Feito isso, informe o comando: <em>composer create-project -s stable bobfreitass/coffee <br> </em>e aguarde alguns segundos.<br> O resultado deverá ser similar a imagem abaixo:<br> <img src="document/img-002.jpg" width="710" height="171" alt=""/><br> <br> <br> </li> <li> Agora basta configurar a conexão com o Banco de Dados MySQL.<br> Para isso, a partir do diretório escolhido, entre em<em> "coffee/config/</em>" e edite o arquivo: <em>database.php</em> conforme sinalizado na imagem abaixo.<br> <img src="document/img-001.jpg" width="939" height="215" alt=""/><br> <em>**Lembrando que ao mudar o nome do Banco de Dados, deve-se faze-lo em 3 pontos especificos.</em><br> <br> </li> </ol> <p>Agora está tudo pronto para testar, pois quando executar-mos a API pela primeira vez, o Banco de Dados será criado e alimentado com os primeiros dados para leitua.</p> <p> </p> <p><strong>TESTANDO A API:</strong></p> <blockquote> <p>Parâmetros a serem testados:</p> <ul> <li>Cadastro de um café (a bebida possui id, nome e descrição como atributos).</li> <li>Listagem de todos os cafés cadastrados</li> <li>Pesquisa de um café por id</li> <li>Não deve ser possível cadastrar o mesmo café duas vezes.</li> <li>Cada endpoint deve utilizar o <strong>verbo HTTP correto</strong> para a ação correspondente.</li> <li>As respostas da API devem ser um <strong>JSON válido</strong>.</li> </ul> </blockquote> <p><strong>VAMOS AOS TESTES:</strong></p> <ol> <li>Abra o programa POSTMAN.</li> <li>Selecione o metodo GET e insira o endereço da API na barra de endereços informando o parametro<strong> <em>/</em></strong><em>listar</em>. Por fim, clique no botão "Send". <br> Esta primeira requisição servirá para que a api crie e alimente o banco de dados.<br> O resultado semelhante ao da imagem abaixo, nos diz que esta tudo certo com as configurações do arquivo <em>config.php </em>. <br> Caso contrário, retorne ao tópico 4 da instalação e revise as configurações.<br> <img src="document/img-003.jpg" width="841" height="830" alt=""/><br> <br> <br> </li> <li>Ainda utilizando o método GET, vamos informar mais um parâmetro em nossa barra de endereços. Mantendo como está no teste anteriror, acrescente uma barra "/" e informe o número de "id" para realizar uma pesquisa.<br> Segue abaixo a imagem com o resultado para o "id 2".<br> <img src="document/img-004.jpg" width="806" height="429" alt=""/><br> <br> <br> Se informarmos um "id" não cadastrado; note que os valores retornam nulos, conforme demonstrado na imagem abaixo.<br> <img src="document/img-005.jpg" width="759" height="417" alt=""/><br> <br> <br> </li> <li>Agora, vamos selecionar o método POST para cadastrar um café.<br> Passe os parâmetro <em> /create</em> logo após o endereço da API, ficando assim: [SEU_SERVIDOR]/[DIRETORIO_INSTALACAO]/coffee/create<br> Selecione a aba "Body", em seguida marque o check "raw" e informe os parâmetros no campo logo abaixo.<br> <br> {<br> "name": "Café Pingado",<br> "description": "Dois terços de leite e um treço de café de qualquer qualidade."<br> }<br> <br> Segue imagem abaixo com o resultado esperado.<br> <img src="document/img-006.jpg" width="755" height="609" alt=""/><br> <br> <br> Caso tentemos cadastrar o mesmo café novamente não conseguiremos, como demonstrado na imagem a seguir.<br> <img src="document/img-007.jpg" width="640" height="617" alt=""/><br> <br> <br> </li> <li>Agora para finalizar, realize uma consulta na lista de cafés para verificar como ficou. <br> Lembrando a instrução do parâmetro no segundo tópico deste item: <em>/listar</em><br> Segue imagem do resultado<br> <img src="document/img-008.jpg" width="826" height="800" alt=""/><br> <br> <br> </li> </ol> <p></p> <p> </p> <p> </p> <p>Finalizo por aqui este documento, deixando um contato a disposição: <em>robertfreitass@gmail.com.br</em> </p> <p> </p> <p><strong>BIBLIOGRAFIA:</strong></p> <blockquote> <p>Conteúdo inserido em nossa lista inicial retirado do site:<em> <a title="https://www.loucodocafe.com.br/tipos-de-cafe/" rel="external nofollow noopener noreferrer" href="https://www.loucodocafe.com.br/tipos-de-cafe/" target="_blank" data-saferedirecturl="https://www.google.com/url?q=https://www.loucodocafe.com.br/tipos-de-cafe/&source=gmail&ust=1593864090937000&usg=AFQjCNFYECxeBv4VtxAk3N8s1E_fDYfDhA">https://www.loucodocafe.com.br/tipos-de-cafe/</a></em></p> </blockquote> </body> </html>