Mewayz の API ドキュメント ジェネレーター
API Docs Generator アドオンは、Mewayz REST API のアプリ内で参照可能なリファレンスを提供します。
Mewayz-オリジナルモジュール — いいえ、Mewayz 上流です。ドキュメントは次のパッケージ ソースから作成されています。
packages/mewayz/ApiDocsGenerator/。
はじめに
API Docs Generator アドオンは、オペレーターとサードパーティ開発者に、Mewayz REST API の検索可能な 1 ページのリファレンスを提供します。これは Swagger UI と同等のアプリ内です。文書化されたすべてのエンドポイント、リクエスト スキーマ、レスポンス スキーマ、およびサンプル ペイロードは管理内でレンダリングされるため、開発者は統合のためにプラットフォームを離れる必要はありません。
ドキュメント面は次のとおりです。 スキーマ駆動型: パッケージは事前に構築された JSON ファイルを次からロードします。 src/documentation/ (ドメインごとに 1 つ: items.json、project.json、account.json など)、マスターによってキー指定されます config.json これには、レンダリングするドメインとその表示名がリストされます。これは、ドキュメントが実際の契約に正確であることを意味します。各リリースにはルートと一致する JSON スキーマの両方が一緒に同梱されるため、ドキュメントがルートから逸脱することはありません。
このモジュールを有効にする方法
API Docs Generator アドオンをセットアップするには、次のリンクをクリックします。 アドオンをセットアップします。
アドオンは次によってゲートされます。 PlanModuleCheck:ApiDocsGenerator。プランまたはテナントごとにアクティブ化します。 アドオン 管理者ページ;アクティブになると、「API Docs」エントリがサイドバーに表示されます。
API ドキュメントへのアクセス方法
- Mewayz にサインインし、次の場所に移動します APIドキュメント サイドバーにあります。
- 単一ページのリファレンスは次の場所にロードされます。
/api-docs。ルートは認証です - - 参照はドメインごとにグループ化されています。各ドメインにはすべてのものがリストされます
ゲート付き (web + auth + verified + PlanModuleCheck)、匿名の訪問者はログイン ページにリダイレクトされます。
HTTP 動詞、パス、必要なヘッダー、リクエスト本文のスキーマ、およびサンプル応答を含む使用可能なエンドポイント。
Mewayz API に対する認証
ここに記載されているすべての Mewayz API エンドポイントは **Laravel Sanctum** によって保護されており、 Authorization ヘッダー。 content-type は、 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 - Products & Services —
/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。テナントごとに個別のドキュメントを維持する必要はありません。