root
33 lines
1.1 KiB
Plaintext
33 lines
1.1 KiB
Plaintext
Al Rahma Sunday School — API Docs Pack
|
|
=================================================
|
|
Generated: 2025-11-07T21:01:43.815073
|
|
|
|
WHAT'S INCLUDED
|
|
---------------
|
|
- app/Controllers/Api/*.php (API controllers)
|
|
- app/Controllers/{DocsController, ApiDocsController}
|
|
- app/Filters/ApiDocsAuthFilter.php
|
|
- app/Views/docs/{index.php, swagger_ui.php, swagger_ui_public.php}
|
|
- public/docs/openapi/*.yaml (separate specs + master.yaml)
|
|
- ROUTES_SNIPPET.php (add to app/Config/Routes.php)
|
|
- FILTERS_SNIPPET.php (add alias to app/Config/Filters.php)
|
|
|
|
INSTALL
|
|
-------
|
|
1) Unzip into your project root.
|
|
2) Merge routes:
|
|
- Open app/Config/Routes.php and paste the contents of ROUTES_SNIPPET.php
|
|
3) Add filter alias:
|
|
- Open app/Config/Filters.php and add the 'apiDocsAuth' alias from FILTERS_SNIPPET.php
|
|
4) Ensure your Models exist and match the controller expectations.
|
|
5) Set JWT secret in .env:
|
|
JWT_SECRET=your_super_secret_key
|
|
6) Visit:
|
|
- /docs (landing)
|
|
- /docs/api (secured, admin only)
|
|
- /docs/api/public (public read-only)
|
|
7) API base path:
|
|
- /api/v1/... (see YAMLs for full paths)
|
|
|
|
Enjoy!
|