feat: added swagger api docs

Author: EncryptEx

app/Http/Controllers/Controller.php

@@ -6,6 +6,23 @@
 use Illuminate\Foundation\Validation\ValidatesRequests;
 use Illuminate\Routing\Controller as BaseController;
 
+/**
+ * @OA\Info(
+ *    title="Femtolink API Documentation",
+ *    version="1.0.0",
+ * )
+ * @OA\Tag(
+ *     name="Links",
+ *     description="Operations about links"
+ *  ),
+ * @OA\SecurityScheme(
+ *     type="http",
+ *     securityScheme="bearerAuth",
+ *     scheme="bearer",
+ *     bearerFormat="JWT"
+ * )
+ *
+ */
 class Controller extends BaseController
 {
     use AuthorizesRequests, ValidatesRequests;

app/Http/Controllers/LinkController.php

@@ -17,6 +17,25 @@ public function get(string $short_url)
         return abort(404);
     }
 
+
+    /**
+ * @OA\Post(
+ *     path="/api/link",
+ *     summary="Create a new shorted link",
+ *     tags={"Links"},
+ *     @OA\Parameter(
+ *         name="long_url",
+ *         in="query",
+ *         description="The long URL to be shortened",
+ *         required=true,
+ *         @OA\Schema(type="string")
+ *     ),
+ *     @OA\Response(response="200", description="Link created successfully"),
+ *     @OA\Response(response="401", description="Unauthorized"),
+ *     @OA\Response(response="400", description="Bad Request"),
+ *     security={{"bearerAuth":{}}}
+ * )
+ */
     public function store(Request $request)
     {
 

composer.json

@@ -6,6 +6,7 @@
     "license": "MIT",
     "require": {
         "php": "^8.1",
+        "darkaonline/l5-swagger": "^8.6",
         "guzzlehttp/guzzle": "^7.2",
         "laravel/framework": "^10.10",
         "laravel/sanctum": "^3.3",