Rodrigogml em 17h00min de 23 de abril de 2025

2025-04-23T17:00:31Z

@@ Linha 38: / Linha 38: @@
+}
 </pre>
 == /api/login ==

Rodrigogml: Criou página com 'Esta página documenta as interfaces públicas (HTTP Handlers) expostas pelo servidor da Engine e do Jogo. A API segue o padrão RESTful com comunicação via JSON padronizada através do modelo '''ApiResponseDTO'''. = Organização dos Handlers = * '''Handlers da Engine''' – Responsáveis por funcionalidades comuns a qualquer jogo usando a Engine PlayTale. * '''Handlers do Jogo''' – Responsáveis pelas lógicas específicas do jogo ''Mystery Realms''. = Formato Ge...'

2025-04-23T02:13:34Z

Criou página com 'Esta página documenta as interfaces públicas (HTTP Handlers) expostas pelo servidor da Engine e do Jogo. A API segue o padrão RESTful com comunicação via JSON padronizada através do modelo '''ApiResponseDTO'''. = Organização dos Handlers = * '''Handlers da Engine''' – Responsáveis por funcionalidades comuns a qualquer jogo usando a Engine PlayTale. * '''Handlers do Jogo''' – Responsáveis pelas lógicas específicas do jogo ''Mystery Realms''. = Formato Ge...'

Página nova

Esta página documenta as interfaces públicas (HTTP Handlers) expostas pelo servidor da Engine e do Jogo. A API segue o padrão RESTful com comunicação via JSON padronizada através do modelo '''ApiResponseDTO'''.

= Organização dos Handlers =
* '''Handlers da Engine''' – Responsáveis por funcionalidades comuns a qualquer jogo usando a Engine PlayTale.
* '''Handlers do Jogo''' – Responsáveis pelas lógicas específicas do jogo ''Mystery Realms''.

= Formato Geral =
* '''Base URL:''' `http://<host>:<porta>/api`
* '''Formato de resposta:''' JSON no padrão:
<pre>
{
"success": true | false,
"code": "código interno",
"message": "descrição",
"data": { ... }
}
</pre>
* '''Cabeçalhos adicionais:'''
:* Quando requerido: `X-Session-Token: <token>`

= Handlers da Engine =

== /api/status ==
* '''Descrição:''' Verifica se a API da Engine está online e retorna sua versão.
* '''Método:''' GET
* '''Autenticação:''' Não requer
* '''Parâmetros:''' Nenhum
* '''Resposta:'''
<pre>
{
"success": true,
"code": "SUCCESS",
"message": "OK",
"data": {
"status": "online",
"version": "1.0.0"
}
}
</pre>

== /api/login ==
* '''Descrição:''' Realiza a autenticação do usuário. Retorna um token de sessão válido para acesso autenticado.
* '''Método:''' POST
* '''Autenticação:''' Não requer
* '''Corpo da requisição:'''
<pre>
{
"username": "string",
"password": "string"
}
</pre>
* '''Resposta (sucesso):'''
<pre>
{
"success": true,
"code": "SUCCESS",
"message": "OK",
"data": {
"token": "UUID"
}
}
</pre>
* '''Resposta (erro - campos obrigatórios):'''
<pre>
{
"success": false,
"code": "PTE_000003",
"message": "Campo obrigatório ausente",
"data": null
}
</pre>
* '''Resposta (erro - autenticação inválida):'''
<pre>
{
"success": false,
"code": "MRS_000001",
"message": "Usuário ou senha incorretos",
"data": null
}
</pre>

= Handlers do Jogo =

<pre>@TODO – Esta seção será preenchida com os endpoints definidos na lógica específica do jogo ''Mystery Realms''.</pre>

API do Servidor - Histórico de revisão

Rodrigogml em 17h00min de 23 de abril de 2025