From aa335bb00480135bdf309e3dc2997881f46ed91f Mon Sep 17 00:00:00 2001
From: HafizMMoaz <hafizmoazkhalid@gmail.com>
Date: Mon, 20 Jul 2026 00:21:10 +0500
Subject: [PATCH] Docs: add API Documentation (Swagger) guide

New developer guide covering the Scramble-generated Swagger UI: viewing
/docs/api and the per-module pages, exporting the OpenAPI JSON, the
local-only access gate, and how to register docs for a new module. Linked
from the Getting Started walkthrough.
---
 .../10-getting-started/getting-started.md     |  3 +
 docs-developer/30-guides/api-documentation.md | 68 +++++++++++++++++++
 2 files changed, 71 insertions(+)
 create mode 100644 docs-developer/30-guides/api-documentation.md

diff --git a/docs-developer/10-getting-started/getting-started.md b/docs-developer/10-getting-started/getting-started.md
index 38e045e..c9b5f3f 100644
--- a/docs-developer/10-getting-started/getting-started.md
+++ b/docs-developer/10-getting-started/getting-started.md
@@ -81,6 +81,9 @@ credentials you set during install (default `admin@zerp.pk` /
 `Admin@1234` if you skipped the prompts), or with the seeded test company
 account `testcompany@zerp.pk` / `Test@1234`.
 
+The interactive API docs (Swagger UI) are at `http://localhost:8000/docs/api`
+once the app is running - see [API Documentation](../30-guides/api-documentation.md).
+
 ## Module images are symlinks - know this before you debug them
 
 Each module ships its own images (favicon, and for the Landing Page module the
diff --git a/docs-developer/30-guides/api-documentation.md b/docs-developer/30-guides/api-documentation.md
new file mode 100644
index 0000000..655413f
--- /dev/null
+++ b/docs-developer/30-guides/api-documentation.md
@@ -0,0 +1,68 @@
+---
+title: API Documentation (Swagger)
+sidebar_position: 4
+---
+
+Zerp's REST API is documented with [Scramble](https://scramble.dedoc.co/),
+which generates an OpenAPI (Swagger) spec straight from the controllers'
+type hints, form requests, and API resources. There are no annotations to
+write or keep in sync - the docs follow the code.
+
+## Viewing the docs
+
+Start the app (`php artisan serve --port=8000`) and open the interactive
+Swagger UI in a browser:
+
+| URL | Scope |
+|---|---|
+| `/docs/api` | Everything - core auth plus every module's API |
+| `/docs/hrm` | HRM module only |
+| `/docs/support-ticket` | Support Ticket module only |
+| `/docs/taskly` | Project (Taskly) module only |
+
+The combined `/docs/api` page is the one to use for a full picture. The
+per-module pages exist only for the modules that ship an API today (HRM,
+Support Ticket, Taskly) and are handy when you are working inside a single
+package. More appear as other modules gain API routes.
+
+## Using the spec
+
+- **Try endpoints live.** Routes behind `auth:*` show an **Authorize**
+  button - paste a Sanctum bearer token and call them from the page.
+- **Export the raw OpenAPI JSON** from the **Download** link on any page, or
+  fetch it directly (`/docs/api.json`, `/docs/hrm.json`, ...). Import it
+  into Postman, Insomnia, or a client generator - this is how the Flutter
+  app and other API consumers stay in sync.
+
+## Access is local-only
+
+`/docs/*` is gated by Scramble's `RestrictedDocsAccess` middleware, so it is
+available in the `local` environment and returns **403 in production**. To
+expose it on a hosted demo, either define a `viewApiDocs` gate or adjust the
+`middleware` list in `config/scramble.php`.
+
+Verify a spec builds without opening a browser:
+
+```bash
+php artisan scramble:analyze --api=hrm
+```
+
+## Adding docs to a new module
+
+A module gets its own scoped page by registering it in the module's service
+provider `boot()`, guarded so the package still works when Scramble is not
+installed:
+
+```php
+if (class_exists(\Dedoc\Scramble\Scramble::class)) {
+    \Dedoc\Scramble\Scramble::registerApi('yourmodule', [
+        'api_path' => 'api/yourprefix',
+        'info' => ['version' => '1.0.0'],
+        'ui' => ['title' => 'Your Module API'],
+    ])->expose(ui: '/docs/yourmodule', document: '/docs/yourmodule.json');
+}
+```
+
+Registering inside the provider keeps the docs travelling with the package.
+The richer your controllers' typed form requests, API resources, and return
+types, the richer the generated spec.