Gerador de documentos API em Mewayz
O complemento API Docs Generator fornece uma referência navegável no aplicativo para a API REST Mewayz.
Mewayz-módulo original — não Mewayz a montante. Documentação de autoria da fonte do pacote em
packages/mewayz/ApiDocsGenerator/.
Introdução
O complemento API Docs Generator oferece aos operadores e desenvolvedores terceirizados uma referência pesquisável de uma página para a API REST Mewayz. É o equivalente no aplicativo de uma UI Swagger – cada endpoint documentado, esquema de solicitação, esquema de resposta e exemplo de carga útil são renderizados dentro do administrador para que um desenvolvedor nunca precise sair da plataforma para integrar.
A superfície da documentação é orientado por esquema: o pacote carrega arquivos JSON pré-construídos de src/documentation/ (um por domínio: items.json, project.json, account.json, etc.), codificado por um mestre config.json que lista quais domínios renderizar e seus nomes de exibição. Isso significa que os documentos são precisos em relação ao contrato real — eles não se afastam das rotas porque cada versão envia as rotas e o esquema JSON correspondente juntos.
Como habilitar este módulo
Para configurar o complemento API Docs Generator, você pode seguir este link: Complemento de configuração.
O Add-On é bloqueado por PlanModuleCheck:ApiDocsGenerator. Ative-o em um plano ou por locatário por meio do Complementos página de administração; uma vez ativo, uma entrada "API Docs" aparece na barra lateral.
Como acessar os documentos da API
- Faça login em Mewayz e navegue até Documentos da API na barra lateral.
- A referência de página única é carregada em
/api-docs. A rota é autorizada - A referência é agrupada por domínio. Cada domínio lista todos
fechado (web + auth + verified + PlanModuleCheck), para que visitantes anônimos sejam redirecionados para a página de login.
endpoint disponível com o verbo HTTP, caminho, cabeçalhos necessários, esquema do corpo da solicitação e exemplo de resposta.
Autenticando na API Mewayz
Todos os endpoints da API Mewayz documentados aqui são protegidos pelo **Laravel Sanctum** e exigem um token de portador no Authorization cabeçalho. O tipo de conteúdo é imposto por meio do api.json middleware – cada solicitação deve incluir Content-Type: application/vnd.api+json (ou cabeçalho JSON equivalente) ou a solicitação será rejeitada antes de chegar ao controlador.
Para emitir um token:
- No menu do perfil do operador, abra Tokens de API.
- Clique Criar token, nomeie-o e copie o segredo imediatamente
- Passe o token em cada chamada de API:
Authorization: Bearer <token>.
(o segredo só é mostrado uma vez).
Cobertura de terminais
Os esquemas JSON incluídos abrangem os seguintes domínios:
- Gerenciamento de usuários -
/api/users,/api/user/store|update|delete|reset-password|verify - Produtos e Serviços -
/api/products,/api/product/create|update|detail|delete, além de categorias, impostos, unidades, estoques em armazém - Gerenciamento de Projetos -
/api/projects,/api/project/{id}/task-board, marcos, rastreamento de bugs - Faturamento de vendas e compras -
/api/sales-invoice,/api/sales-invoice-return,/api/purchase-invoice,/api/purchase-return - Transferências de armazém e estoque -
/api/warehouse,/api/warehouse/product/{warehouse_id},/api/transfer - Propostas de Vendas -
/api/sales-proposal - Gestão de Recursos Humanos -
/api/employees,/api/attendance,/api/leave-application,/api/payrolls - CRM e leads -
/api/leads,/api/deal/*,/api/pipeline,/api/lead-stage,/api/labels,/api/sources - Contabilidade -
/api/chart-of-accounts,/api/customers,/api/vendors,/api/bank-accounts,/api/revenues,/api/expenses - PDV -
/api/pos
Permissões
A visibilidade da entrada API Docs na barra lateral é controlada pela permissão Spatie manage-api-docs. Operadores sem essa permissão não veem a entrada do menu e recebem um 403 se visitarem /api-docs diretamente.
Notas do Operador
- A documentação é somente leitura hoje - não há "Experimente"
- Os esquemas JSON residem no controle de origem em
- Os locatários de marca branca veem automaticamente a superfície dos documentos com escopo definido para
botão para executar chamadas ao vivo na página de documentos. (Use uma ferramenta como Postman ou curl para testar em relação aos endpoints documentados.)
packages/mewayz/ApiDocsGenerator/src/documentation/. Quando novos endpoints de API são enviados, o arquivo JSON correspondente é adicionado ou estendido na mesma versão.
seu próprio nome de marca e URL base; nenhuma documentação separada precisa ser mantida por inquilino.