phpmx/server

Camada para servidor de API via PHPMX

1.2 2025-06-26 14:08 UTC

Requires

• phpmx/core: ^1.1

MIT

• André Ricardo

README

Módulo de servidor para criação de APIs e aplicações web modernas com PHPMX.

Dependência

• phpmx-core

Instalação

A instalação é feita em um projeto vazio ou junto ao phpmx-core, utilizando apenas dois comandos no terminal:

composer require phpmx/server
.\vendor\bin\mx install

Você pode verificar se tudo está pronto executando o comando abaixo:

php mx

Estrutura de Pastas

Este pacote adiciona quatro itens estruturais ao seu projeto:

• middleware: Middlewares para tratamento de requisições e respostas.
• routes: Definição das rotas da aplicação/API.
• source/Controller: Controladores da aplicação/API.
• index.php: Arquivo principal de entrada da aplicação.

middleware

Defina middlewares úteis para seu projeto. Middlewares são funções que processam a requisição antes ou depois do controlador principal.

return function($request, $next) {
    // Lógica do middleware
    return $next($request);
};

Você pode criar novos middlewares utilizando o comando:

php mx create.middleware minhaMiddleware

routes

Defina suas rotas HTTP (GET, POST, etc) neste diretório. Você é livre para criar qualquer arquivo PHP que sua organização exigir. Dentro dos arquivos, utilize a classe Router para declarar suas rotas:

Route::get('/home', 'controller:method',['middleware1','middleware2']);

source/Controller

Coloque aqui seus controladores. Cada controlador deve ser uma classe PHP responsável por tratar as requisições de uma rota específica ou grupo de rotas. Organize seus controladores conforme a lógica da sua aplicação.

Você pode criar novos controllers utilizando o comando:

php mx create.controller meuController

index.php

Arquivo principal de entrada da aplicação. Toda requisição HTTP deve ser direcionada para este arquivo.

Todas as requisições devem ser redirecionadas para o arquivo index.php, independentemente da existência de arquivos, extensões ou pastas com o mesmo nome da URL requisitada. O servidor não deve servir nenhum arquivo ou diretório diretamente. A responsabilidade do roteamento é exclusiva da aplicação.

Documentação

• Helper

  • constant
  • environment
  • function
  • middleware
  • routes

• Source

  • Assets
  • Input
  • Jwt
  • Middleware
  • Request
  • Response
  • Router

• Terminal

  • create
  • help
  • server

phpmx | phpmx-core | phpmx-server | phpmx-datalayer | phpmx-view