Generator dokumentów API mewayz

Generator dokumentów API w Mewayz

Dodatek API Docs Generator umożliwia przeglądanie w aplikacji informacji o interfejsie API REST Mewayz.

Mewayz – moduł oryginalny — nie Mewayz w górę rzeki. Dokumentacja utworzona ze źródła pakietu pod adresem packages/mewayz/ApiDocsGenerator/.

Adres URL wersji demonstracyjnej

Wprowadzenie

Dodatek API Docs Generator zapewnia operatorom i zewnętrznym programistom jednostronicowe, przeszukiwalne źródło informacji o interfejsie API REST Mewayz. Jest to odpowiednik interfejsu użytkownika Swagger w aplikacji — każdy udokumentowany punkt końcowy, schemat żądań, schemat odpowiedzi i przykładowy ładunek są renderowane wewnątrz administratora, dzięki czemu programista nigdy nie musi opuszczać platformy w celu integracji.

Powierzchnia dokumentacji to kierowane schematem: pakiet ładuje gotowe pliki JSON z src/documentation/ (jeden na domenę: items.json, projekt.json, account.json itp.), z kluczem głównym config.json która zawiera listę domen do renderowania i ich wyświetlane nazwy. Oznacza to, że dokumenty są zgodne z rzeczywistą umową — nie odbiegają od tras, ponieważ w każdym wydaniu znajdują się zarówno trasy, jak i pasujący schemat JSON.

Jak włączyć ten moduł

Aby skonfigurować dodatek API Docs Generator, kliknij ten link: Skonfiguruj dodatek.

Dodatek jest bramkowany przez PlanModuleCheck:ApiDocsGenerator. Aktywuj go w ramach planu lub dla poszczególnych najemców za pośrednictwem Dodatki strona administratora; po aktywacji na pasku bocznym pojawi się wpis „Dokumenty API”.

Jak uzyskać dostęp do dokumentów API

• Zaloguj się do Mewayz i przejdź do Dokumenty API na pasku bocznym.
• Jednostronicowe odniesienie ładuje się o godz /api-docs. Trasa jest autentyczna

ogrodzony (web + auth + verified + PlanModuleCheck), dzięki czemu anonimowi odwiedzający zostaną przekierowani na stronę logowania.

• Odniesienie jest pogrupowane według domeny. Każda domena zawiera listę wszystkich

dostępny punkt końcowy z czasownikiem HTTP, ścieżką, wymaganymi nagłówkami, schematem treści żądania i przykładową odpowiedzią.

Uwierzytelnianie w interfejsie API Mewayz

Wszystkie udokumentowane tutaj punkty końcowe API Mewayz są chronione przez **Laravel Sanctum** i wymagają tokena nośnika w Authorization nagłówek. Typ zawartości jest wymuszany poprzez api.json oprogramowanie pośrednie — każde żądanie musi zawierać Content-Type: application/vnd.api+json (lub równoważny nagłówek JSON) lub żądanie zostanie odrzucone przed dotarciem do kontrolera.

Aby wystawić token:

• Z menu profilu operatora otwórz Tokeny API.
• Kliknij Utwórz token, nazwij go i natychmiast skopiuj klucz tajny

(sekret pokazany jest tylko raz).

• Przekaż token przy każdym wywołaniu API: Authorization: Bearer <token>.

Pokrycie punktów końcowych

Dołączone schematy JSON obejmują następujące domeny:

• Zarządzanie użytkownikami — /api/users, /api/user/store|update|delete|reset-password|verify
• Produkty i usługi — /api/products, /api/product/create|update|detail|delete, plus kategorie, podatki, jednostki, stany magazynowe
• Zarządzanie projektami — /api/projects, /api/project/{id}/task-board, kamienie milowe, śledzenie błędów
• Fakturowanie sprzedaży i zakupu — /api/sales-invoice, /api/sales-invoice-return, /api/purchase-invoice, /api/purchase-return
• Przeniesienia magazynów i zapasów — /api/warehouse, /api/warehouse/product/{warehouse_id}, /api/transfer
• Propozycje sprzedaży — /api/sales-proposal
• Zarządzanie zasobami ludzkimi — /api/employees, /api/attendance, /api/leave-application, /api/payrolls
• CRM i potencjalni klienci — /api/leads, /api/deal/*, /api/pipeline, /api/lead-stage, /api/labels, /api/sources
• Księgowość — /api/chart-of-accounts, /api/customers, /api/vendors, /api/bank-accounts, /api/revenues, /api/expenses
• punkt sprzedaży — /api/pos

Uprawnienia

Widoczność wpisu Dokumentów API na pasku bocznym jest kontrolowana przez pozwolenie Spatie manage-api-docs. Operatorzy bez tego uprawnienia nie widzą pozycji menu i w przypadku wizyty otrzymują komunikat 403 /api-docs bezpośrednio.

Uwagi operatora

• Dokumentacja jest tylko do odczytu dzisiaj — nie ma „spróbuj”

przycisk umożliwiający wykonywanie połączeń na żywo ze strony dokumentów. (Użyj narzędzia takiego jak Postman lub curl do testowania względem udokumentowanych punktów końcowych.)

• Schematy JSON znajdują się w kontroli źródła pod adresem

packages/mewayz/ApiDocsGenerator/src/documentation/. Po dostarczeniu nowych punktów końcowych API pasujący plik JSON jest dodawany lub rozszerzany w tej samej wersji.

• Najemcy z białą etykietą automatycznie widzą zakres dokumentów

własną markę i bazowy adres URL; nie ma potrzeby prowadzenia oddzielnej dokumentacji dla każdego najemcy.