Cesar959 / api-crud

API REST CRUD (Application Programming Interface), com as funcionalidades de cadastro, alteração, visualização e exclusão de registros de usuários

Home Page:https://cesar959.github.io/api-crud/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

API REST Crud

imagem-site

Projeto API REST Crud (Create, Read, Update, Delete)

Descrição

O projeto é uma API REST aonde é possível cadastrar, alterar, ler e excluir usuarios. Interface de Programação de Aplicações (português) cuja sigla API provém do Inglês Application Programming Interface, é um conjunto de rotinas e padrões estabelecidos por um software para a utilização das suas funcionalidades.

API conta com 5 funcionalidades básicas: obter todos os registros, selecionar um unico registro, cadastrar registro, atualizar o registro e deletar o registro. Até o momento não foi implementado um sistema de autenticação para utilizar a API, possibilitando assim a utilização pública da mesma.

Para isso foi utilizando o PHP para realizar execução de instruções SQL no banco de dados phpMyAdmin, além disso foi utilizado POO (Programação Orientada a Objetos) e PDO (PHP Data Object) na construção das class. Na arquitetura do projeto foi usado o Composer para fazer autoload das class e o htaccess que permite usar as URLs amigaveis. Na pasta DOC você encontra todo o planejamento do projeto como o desenho da modelagem do banco de dados e o próprio banco de dados exportado.

Rotas:

É a mesma rota para todos o que diferencia é o método, para GET e DELETE é utilizado o id_usuario do registro como parâmetro. Alem disso o unico serviço disponivel até o momento é "usuarios".

POST

Cadastra os dados no banco de dados

https://seudominio.com/api_crud/usuarios/

GET

Traz todos os registros

https://seudominio.com/api_crud/usuarios/

GET

Traz um registo específico (o caso em questão, vai trazer os dados referente ao id_usuarios 2)

https://seudominio.com/api_crud/usuarios/2

PUT

Atualiza os dados no banco de dados. Aviso: na atualização do registro é obrigatorio o envio de todos os dados (id_usuarios, nome, idade, sexo, email, senha) mesmo aqueles que não sofrerão alteraçãoes.

https://seudominio.com/api_crud/usuarios/

DELETE

Excluir o registro baseado no id_usuarios (o caso em questão, vai excluir os dados referente ao id_usuarios 2)

https://seudominio.com/api_crud/usuarios/2

Instalação Local

Para executar esse projeto você precisara do Composer.

Por meio dele sera baixado todas as depedencias do projeto, depois de instalado execute os comandos abaixo na linha do terminal.

  1. Para baixa todas as dependencias do projeto
composer update 
  1. Efetuar o carregamento automatico das class
composer dump-autoload 
  1. Edite as configurações padrão do arquivo config.php
define("HOST","localhost"); 
define("BANCO","crud-container"); 
define("USUARIO","root"); 
define("SENHA",""); 
define("BASEURL", "http://localhost/api_crud/"); 

Status do Projeto

Concluido: O projeto esta terminado, não havera futuras alterações de funcionalidade.

Construído com

  • JSON - Em computação, JSON, um acrônimo de JavaScript Object Notation, é um formato compacto, de padrão aberto independente, de troca de dados simples e rápida entre sistemas, especificado por Douglas Crockford em 2000, que utiliza texto legível a humanos, no formato atributo-valor.

  • PHP - PHP é uma linguagem interpretada livre, usada originalmente apenas para o desenvolvimento de aplicações presentes e atuantes no lado do servidor, capazes de gerar conteúdo dinâmico na World Wide Web.

  • SQL - Structured Query Language, ou Linguagem de Consulta Estruturada ou SQL, é a linguagem de pesquisa declarativa padrão para banco de dados relacional. Muitas das características originais do SQL foram inspiradas na álgebra relacional.

  • Composer - O Composer é um gerenciador de pacotes no nível do aplicativo para a linguagem de programação PHP que fornece um formato padrão para gerenciar dependências do software PHP e bibliotecas necessárias. Foi desenvolvido por Nils Adermann e Jordi Boggiano, que continuam a gerenciar o projeto.

Versão das Linguagens e Ferramentas

Servidor de base de dados

  • MariaDB - 10.4.21-MariaDB

Servidor web

  • PHP - 7.3.31
  • Apache - 2.4.51

Gerenciamento do banco de dados

  • phpMyAdmin - 5.1.1

Ferramentas

  • Xampp - 3.3.0

Autor

  • Cesar dos Santos de Almeida - responsável pela construção e desenvolvimento do projeto

Licença

Este projeto está licenciado sob a licença MIT - consulte o arquivo LICENSE.md para obter detalhes

Links

About

API REST CRUD (Application Programming Interface), com as funcionalidades de cadastro, alteração, visualização e exclusão de registros de usuários

https://cesar959.github.io/api-crud/

License:MIT License


Languages

Language:PHP 100.0%