Mewayz'da API Doküman Oluşturucu
API Docs Generator Eklentisi, Mewayz REST API için uygulama içi, göz atılabilir bir referans sağlar.
Mewayz-orijinal modül — hayır Mewayz yukarı akış. Şu adresteki paket kaynağından yazılan belgeler:
packages/mewayz/ApiDocsGenerator/.
Giriş
API Docs Generator Eklentisi, operatörlere ve üçüncü taraf geliştiricilere Mewayz REST API için tek sayfalık, aranabilir bir referans sağlar. Swagger kullanıcı arayüzünün uygulama içi eşdeğeridir; belgelenen her uç nokta, istek şeması, yanıt şeması ve örnek yük yönetici içinde işlenir, böylece geliştiricinin entegrasyon için platformdan ayrılmasına gerek kalmaz.
Dokümantasyon yüzeyi şema odaklı: paket önceden oluşturulmuş JSON dosyalarını yükler src/documentation/ (etki alanı başına bir tane: items.json, project.json, account.json vb.), bir ana anahtar tarafından anahtarlanır config.json hangi etki alanlarının oluşturulacağını ve görünen adlarını listeler. Bu, dokümanların gerçek sözleşmeye uygun olduğu anlamına gelir; rotalardan sapmazlar çünkü her sürüm, hem rotaları hem de eşleşen JSON şemasını birlikte gönderir.
Bu modül nasıl etkinleştirilir
API Docs Generator Eklentisini Kurmak için şu bağlantıyı takip edebilirsiniz: Eklentiyi Kur.
Eklentinin kapısı şu şekildedir: PlanModuleCheck:ApiDocsGenerator. Bunu bir plan üzerinde veya kiracı aracılığıyla etkinleştirin. Eklentiler yönetici sayfası; etkinleştirildiğinde kenar çubuğunda bir "API Dokümanları" girişi görünür.
API Dokümanlarına Nasıl Erişilir?
- Mewayz'da oturum açın ve şuraya gidin: API Dokümanları kenar çubuğunda.
- Tek sayfalı referans şu saatte yüklenir:
/api-docs. Rota yetkilidir - Referans etki alanına göre gruplandırılmıştır. Her alan adı her birini listeler
kapılı (web + auth + verified + PlanModuleCheck), böylece anonim ziyaretçiler giriş sayfasına yönlendirilir.
HTTP fiili, yol, gerekli başlıklar, istek gövdesi şeması ve örnek yanıtla birlikte kullanılabilir uç nokta.
Mewayz API'sinde kimlik doğrulama
Burada belgelenen tüm Mewayz API uç noktaları **Laravel Sanctum** tarafından korunmaktadır ve Authorization başlık. İçerik türü aracılığıyla uygulanır api.json ara yazılım — her isteğin içermesi gerekir Content-Type: application/vnd.api+json (veya eşdeğer JSON başlığı) veya istek, denetleyiciye ulaşmadan reddedilir.
Bir jeton düzenlemek için:
- Operatörün profil menüsünden açın API Belirteçleri.
- Tıklayın Jeton Oluştur, adlandırın ve sırrı hemen kopyalayın
- Belirteci her API çağrısında iletin:
Authorization: Bearer <token>.
(sır yalnızca bir kez gösterilir).
Uç Nokta Kapsamı
Paketlenmiş JSON şemaları aşağıdaki alanları kapsar:
- Kullanıcı Yönetimi —
/api/users,/api/user/store|update|delete|reset-password|verify - Ürün ve Hizmetler —
/api/products,/api/product/create|update|detail|deleteartı kategoriler, vergiler, birimler, depo stokları - Proje Yönetimi —
/api/projects,/api/project/{id}/task-board, kilometre taşları, hata takibi - Satış ve Satın Alma Faturalandırması —
/api/sales-invoice,/api/sales-invoice-return,/api/purchase-invoice,/api/purchase-return - Depo ve Envanter Transferleri —
/api/warehouse,/api/warehouse/product/{warehouse_id},/api/transfer - Satış Teklifleri —
/api/sales-proposal - İKY —
/api/employees,/api/attendance,/api/leave-application,/api/payrolls - CRM ve Potansiyel Müşteriler —
/api/leads,/api/deal/*,/api/pipeline,/api/lead-stage,/api/labels,/api/sources - Muhasebe —
/api/chart-of-accounts,/api/customers,/api/vendors,/api/bank-accounts,/api/revenues,/api/expenses - POS —
/api/pos
İzinler
Kenar çubuğundaki API Dokümanları girişinin görünürlüğü Spatie izniyle kontrol edilir manage-api-docs. Bu izne sahip olmayan operatörler menü girişini görmezler ve ziyaret ettiklerinde 403 alırlar. /api-docs doğrudan.
Operatör Notları
- Belgeler salt okunur bugün - "Deneyin" diye bir şey yok
- JSON şemaları kaynak kontrolünde bulunur
- Beyaz etiketli kiracılar, kapsamı belirlenen doküman yüzeyini otomatik olarak görür
aramaları dokümanlar sayfasından canlı olarak yürütmek için düğme. (Postacı gibi bir araç kullanın veya curl belgelenen uç noktalara karşı test etmek için.)
packages/mewayz/ApiDocsGenerator/src/documentation/. Yeni API uç noktaları gönderildiğinde eşleşen JSON dosyası aynı sürüme eklenir veya genişletilir.
kendi marka adları ve temel URL'leri; kiracı başına ayrı bir belge tutulmasına gerek yoktur.