API simples para integração com jogos digitais, por exemplo Godot. Ela apresenta recursos para criação de usuário, login, criação de instância de jogos, salvamento, placar e ranking.
PHP 7.4.3 (cli) (built: Jul 5 2021 15:13:35) ( NTS )
Copyright (c) The PHP Group Zend Engine v3.4.0,
Copyright (c) Zend Technologies with Zend OPcache v7.4.3,
Copyright (c), by Zend Technologies
Este conteúdo é livre para uso e distribuição sob a licença (CC BY-SA 4.0).
Se quiser colaborar neste repositório com melhorias ou correções, basta fazer um fork e enviar um PR.
+---api
\class\
GameModel.php
PDOConnection.php
UserModel.php
game.php
scripts.sql
teste.httpd
user.php
Esta API utiliza o banco de dados MySQL 5, que pode ser alterado a qualquer momento de acordo com a necessidade de uso. O banco de dados deve ser configurado em \class\PDOConnection.php.
CREATE DATABASE name;
CREATE TABLE users
(
id INT(11) NOT NULL PRIMARY KEY AUTO_INCREMENT,
name VARCHAR(100) NOT NULL,
user VARCHAR(100) NOT NULL,
password VARCHAR(100) NOT NULL
);
CREATE TABLE games
(
id INT(11) NOT NULL PRIMARY KEY AUTO_INCREMENT,
user_id INT(11),
score INT(11)
);
Resource | URI | Method |
---|---|---|
NEW | http://URI/api/user.php |
POST |
header
{
"content-type": "application/json"
}
payload
{
"type": "new",
"name": "name",
"user": "username",
"password": "password"
}
Success
{
"data": "ok",
"value": "user_created_successfully"
}
Warnings
{
"data": "err",
"value": "invalid_data"
}
{
"data": "err",
"value": "user_[...]_exists"
}
Resource | URI | Method |
---|---|---|
LOGIN | http://URI/api/user.php |
POST |
header
{
"content-type": "application/json"
}
payload
{
"type": "login",
"user": "username",
"password": "password"
}
Success
{
"id": 5,
"user": "username",
"name": "name",
"data": "ok"
}
Warnings
{
"data": "err",
"value": "invalid_data"
}
{
"data": "err",
"value": "user_not_found"
}
Resource | URI | Method |
---|---|---|
USERS | http://URI/api/user.php |
POST |
header
{
"content-type": "application/json"
}
payload
{
"type": "users"
}
Success
{
"0": {
"user": "name"
},
"1": {
"user": "name"
},
"data": "ok"
}
Warnings
{
"data": "err",
"value": "invalid_data"
}
{
"data": "err",
"value": "there_are_no_users_to_list"
}
Resource | URI | Method |
---|---|---|
NEW | http://URI/api/game.php |
POST |
header
{
"content-type": "application/json"
}
payload
{
"type": "new",
"user_id": "value"
}
Resource | URI | Method |
---|---|---|
SAVE | http://URI/api/game.php |
POST |
{
"content-type": "application/json"
}
Payload
{
"type":"save",
"game_id":value,
"score":3000
}
Resource | URI | Method |
---|---|---|
RANKING GENERAL | http://URI/api/game.php |
POST |
{
"content-type": "application/json"
}
{
"type":"ranking_general"
}
Resource | URI | Method |
---|---|---|
RANKING USER | http://URI/api/game.php |
POST |
{
"content-type": "application/json"
}
{
"type":"ranking_player",
"user_id": user_id
}
DE SOUZA, Edson Melo (2022, October 6). PHP API GAMES v.1.0.
Available in: https://github.com/EdsonMSouza/apigames
Ou BibTeX for LaTeX:
@misc{desouza2022apigame,
author = {DE SOUZA, Edson Melo},
title = {PHP API GAMES v.1.0},
url = {https://github.com/EdsonMSouza/apigames},
year = {2022},
month = {October}
}
Este trabalho é licenciado sob a Creative Commons Attribution-ShareAlike 4.0 International License.