Генератор документов API в Mewayz
Надстройка API Docs Generator предоставляет доступную для просмотра в приложении ссылку на Mewayz REST API.
Mewayz-исходный модуль — нет Mewayz вверх по течению. Документация создана из исходного кода пакета по адресу
packages/mewayz/ApiDocsGenerator/.
Введение
Надстройка API Docs Generator предоставляет операторам и сторонним разработчикам одностраничный справочник с возможностью поиска по Mewayz REST API. Это эквивалент пользовательского интерфейса Swagger внутри приложения — каждая документированная конечная точка, схема запроса, схема ответа и пример полезной нагрузки отображаются внутри администратора, поэтому разработчику никогда не придется покидать платформу для интеграции.
Поверхность документации управляемый схемой: пакет загружает предварительно созданные файлы JSON из src/documentation/ (по одному на домен: items.json, project.json, account.json и т. д.), с ключом мастера config.json в нем перечислены домены для отображения и их отображаемые имена. Это означает, что документы соответствуют фактическому контракту — они не отклоняются от маршрутов, поскольку в каждом выпуске и маршруты, и соответствующая схема JSON поставляются вместе.
Как включить этот модуль
Чтобы настроить надстройку API Docs Generator, вы можете перейти по этой ссылке: Настройка дополнения.
Дополнение закрыто PlanModuleCheck:ApiDocsGenerator. Активируйте его для плана или отдельного клиента через Дополнения страница администратора; После активации на боковой панели появится запись «Документы API».
Как получить доступ к документации API
- Войдите в систему Mewayz и перейдите к Документация по API в боковой панели.
- Одностраничная ссылка загружается с
/api-docs. Маршрут авторизован - Ссылка сгруппирована по домену. В каждом домене перечислены все
закрытый (web + auth + verified + PlanModuleCheck), поэтому анонимные посетители перенаправляются на страницу входа.
доступная конечная точка с HTTP-командой, путем, обязательными заголовками, схемой тела запроса и примером ответа.
Аутентификация по API Mewayz
Все описанные здесь конечные точки API Mewayz защищены **Laravel Sanctum** и требуют токена-носителя в Authorization заголовок. Тип контента применяется через api.json промежуточное программное обеспечение — каждый запрос должен включать Content-Type: application/vnd.api+json (или эквивалентный заголовок JSON), либо запрос отклоняется до достижения контроллера.
Чтобы выпустить токен:
- В меню профиля оператора откройте API-токены.
- Нажмите Создать токен, назовите его и немедленно скопируйте секрет
- Передавайте токен при каждом вызове API:
Authorization: Bearer <token>.
(секрет показан только один раз).
Покрытие конечных точек
Входящие в комплект схемы JSON охватывают следующие домены:
- Управление пользователями —
/api/users,/api/user/store|update|delete|reset-password|verify - Продукты и услуги —
/api/products,/api/product/create|update|detail|delete, плюс категории, налоги, единицы, складские запасы - Управление проектами —
/api/projects,/api/project/{id}/task-board, этапы, отслеживание ошибок - Выставление счетов за продажу и покупку —
/api/sales-invoice,/api/sales-invoice-return,/api/purchase-invoice,/api/purchase-return - Складские и инвентарные перемещения —
/api/warehouse,/api/warehouse/product/{warehouse_id},/api/transfer - Коммерческие предложения —
/api/sales-proposal - Управление персоналом —
/api/employees,/api/attendance,/api/leave-application,/api/payrolls - CRM и потенциальные клиенты —
/api/leads,/api/deal/*,/api/pipeline,/api/lead-stage,/api/labels,/api/sources - Бухгалтерский учет —
/api/chart-of-accounts,/api/customers,/api/vendors,/api/bank-accounts,/api/revenues,/api/expenses - POS-терминал —
/api/pos
Разрешения
Видимость записи API Docs на боковой панели контролируется разрешением Spatie. manage-api-docs. Операторы без этого разрешения не видят пункт меню и получают код 403 при посещении. /api-docs напрямую.
Примечания оператора
- Документация только для чтения сегодня — нет «Попробуй»
- Схемы JSON находятся в системе контроля версий по адресу
- Арендаторы с белой меткой автоматически видят поверхность документов, ограниченную областью действия.
Кнопка для выполнения вызовов в реальном времени со страницы документации. (Используйте такой инструмент, как Postman или curl для тестирования на соответствие задокументированным конечным точкам.)
packages/mewayz/ApiDocsGenerator/src/documentation/. При выпуске новых конечных точек API соответствующий файл JSON добавляется или расширяется в той же версии.
собственный бренд и базовый URL-адрес; для каждого арендатора не требуется вести отдельную документацию.