Add API documentation using Swagger UI

Arman001011 · Jan 15, 2025 · 4a638f2 · 4a638f2
1 parent 9abe268
commit 4a638f2
Show file tree

Hide file tree

Showing 11 changed files with 1,257 additions and 79 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,10 @@ To install the project with Docker please make sure you have installed it on you
 
 `php artisan db:seed`
 
-# Now the app will be available at http://localhost:8080.
+## Make storage accessible
+
+`php artisan storage:link`
+
+# Now the app will be available at http://localhost:8080. And API documentation will be visible at http://localhost:8080/api/documentation. 
 
 ### If you need to stop the containers, you can run `docker-compose down` and run `docker-compose up -d` to restart them. Artisan commands can be run from outside of containers like `docker exec -it laravel_app php artisan migrate`.
diff --git a/composer.json b/composer.json
@@ -7,6 +7,7 @@
     "license": "MIT",
     "require": {
         "php": "^8.2",
+        "darkaonline/l5-swagger": "^8.6",
         "laravel/framework": "^11.31",
         "laravel/sanctum": "^4.0",
         "laravel/tinker": "^2.9",