← Documentation·Autre

Générateur de documentation d'API Mewayz

●  Mis à jour en mai 2026Mewayz

Générateur de documentation API dans Mewayz

L'add-on Générateur de docs API fournit une référence intégrée et navigable de l'API REST Mewayz.

module Mewayz-original — aucun Mewayz en amont. Documentation rédigée à partir du code source du package à l'adresse packages/mewayz/ApiDocsGenerator/.

URL de démo

Dans le produit
app.mewayz.com/api/docs
Documentation API
Documentation API

Introduction

Le module Générateur de documentation d'API offre aux opérateurs et aux développeurs tiers une référence d'une seule page, consultable, pour l'API REST de Mewayz. C'est l'équivalent intégré d'une interface Swagger — chaque point de terminaison documenté, schéma de requête, schéma de réponse et exemple de charge utile est affiché dans l'admin, afin qu'un développeur n'ait jamais à quitter la plateforme pour réaliser une intégration.

La surface de documentation est piloté par schéma: le package charge des fichiers JSON pré-construits depuis src/documentation/ (un par domaine : items.json, project.json, account.json, etc.), indexé par un maître config.json qui répertorie les domaines à afficher et leurs noms d'affichage. Cela signifie que la documentation correspond fidèlement au contrat réel — elle ne s'écarte pas des routes, car chaque version livre à la fois les routes et le schéma JSON correspondant.

Comment activer ce module

Pour configurer le module complémentaire Générateur de docs API, suivez ce lien : Module complémentaire de configuration.

Le module complémentaire est restreint par PlanModuleCheck:ApiDocsGenerator. Activez-le sur un forfait ou par locataire via le Modules complémentaires page admin ; une fois activée, une entrée « API Docs » apparaît dans la barre latérale.

Comment accéder à la documentation de l'API

Authentification auprès de l'API Mewayz

Tous les points de terminaison de l'API Mewayz documentés ici sont protégés par **Laravel Sanctum** et nécessitent un jeton bearer dans la Authorization en-tête. Le type de contenu est imposé via le api.json middleware — chaque requête doit inclure Content-Type: application/vnd.api+json (ou un en-tête JSON équivalent), sinon la requête est rejetée avant d'atteindre le contrôleur.

Pour émettre un jeton :

Couverture des points de terminaison

Les schémas JSON fournis couvrent les domaines suivants :

Autorisations

La visibilité de l'entrée Documentation API dans la barre latérale est contrôlée par une permission Spatie manage-api-docs. Les opérateurs sans cette autorisation ne voient pas l'entrée de menu et reçoivent une erreur 403 s'ils s'y rendent /api-docs directement.

Notes de l’opérateur

Cela vous a-t-il été utile ?
← Tous les docsDemandez à l'équipeEssayez gratuitement →