First pass at swagger docs

Author: joeySchentrup

src/Router.php

@@ -11,6 +11,7 @@
 use PhpApi\Model\Request\AbstractRequest;
 use PhpApi\Model\Response\AbstractResponse;
 use PhpApi\Model\RouterOptions;
+use PhpApi\Swagger\GenerateSwaggerDocs;
 use PhpApi\Utility\Arrays;
 use ReflectionClass;
 use ReflectionFunction;
@@ -20,6 +21,13 @@
 
 class Router
 {
+    public const StaticRoutes = [
+        'GET' => [
+            '/swagger' => 'handleSwaggerPage',
+            '/swagger/json' => 'handleSwaggerJson',
+        ],
+    ];
+
     protected AutoRoute $autoRoute;
 
     /** @var IRequestMiddleware[] $requestMiddlewares */
@@ -31,6 +39,9 @@ class Router
     /** @var array<int, callable> $errorHandlers */
     private array $errorHandlers = [];
 
+    /**
+     * @param callable|null $controllerFactory
+     */
     public function __construct(
         private RouterOptions $routerOptions,
         private mixed $controllerFactory = null,
@@ -60,6 +71,12 @@ public function route(?Request $request = null): void
             $request = new Request();
         }
 
+        if (isset(self::StaticRoutes[$request->method->name][$request->url->path])) {
+            $method = self::StaticRoutes[$request->method->name][$request->url->path];
+            $this->$method();
+            return;
+        }
+
         $route = $this->autoRoute->getRouter()
             ->route($request->method->name ?? 'GET', $request->url->path ?? '');
 
@@ -212,4 +229,25 @@ private function defaultErrorHandler(): Response
 
         return $response;
     }
+
+    private function handleSwaggerJson(): void
+    {
+        $response = new Response();
+        $response->setCode(200);
+        $response->setHeader('Content-Type', 'application/json');
+        $response->setContent((new GenerateSwaggerDocs(
+            $this->autoRoute,
+            $this->routerOptions,
+        ))->generate());
+        $response->send();
+    }
+
+    private function handleSwaggerPage(): void
+    {
+        $response = new Response();
+        $response->setCode(200);
+        $response->setHeader('Content-Type', 'text/html');
+        $response->setContent(file_get_contents(__DIR__ . '/../swagger/index.html'));
+        $response->send();
+    }
 }

src/Swagger/GenerateSwaggerDocs.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace PhpApi\Swagger;
+
+use AutoRoute\AutoRoute;
+use PhpApi\Model\RouterOptions;
+use ReflectionClass;
+use ReflectionException;
+
+class GenerateSwaggerDocs
+{
+    public function __construct(
+        private readonly AutoRoute $autoRoute,
+        private readonly RouterOptions $routerOptions,
+    ) {
+    }
+
+    public function generate(): string
+    {
+        $urls = $this->autoRoute->getDumper()->dump();
+        $swaggerDocs = $this->generateSwagger($urls);
+        return json_encode($swaggerDocs);
+    }
+
+    /**
+     * @param array<string, array<string, string>> $urls url[path][httpMethod] = class
+     * @return array
+     */
+    private function generateSwagger(array $urls): array
+    {
+        $swagger = [];
+        foreach ($urls as $path => $methods) {
+            foreach ($methods as $method => $class) {
+                $reflectionClass = new ReflectionClass($class);
+                try {
+                    $reflectionMethod = $reflectionClass->getMethod($this->routerOptions->method);
+                } catch (ReflectionException $e) {
+                    continue;
+                }
+
+                echo $method . ' ' . $path . '<br>';
+                echo 'Class: ' . $class . '<br>';
+                echo 'Method: ' . $reflectionMethod->getName() . '<br>';
+            }
+        }
+        return $swagger;
+    }
+}

src/Swagger/Model/Contact.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace PhpApi\Swagger\Model;
+
+class Contact
+{
+	public function __construct(public readonly string $email)
+	{
+	}
+}

src/Swagger/Model/ContentType.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace PhpApi\Swagger\Model;
+
+class ContentType
+{
+    /**
+     * @param array<string, string> $schema
+     */
+    public function __construct(
+        public readonly Schema $schema,
+        public readonly mixed $example,
+    ) {
+    }
+}

src/Swagger/Model/ExternalDocs.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace PhpApi\Swagger\Model;
+
+class ExternalDocs
+{
+	public function __construct(public readonly string $description, public readonly string $url)
+	{
+	}
+}

src/Swagger/Model/Info.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace PhpApi\Swagger\Model;
+
+class Info
+{
+	public function __construct(
+		public readonly string $title,
+		public readonly string $description,
+		public readonly string $termsOfService,
+		public readonly Contact $contact,
+		public readonly License $license,
+		public readonly string $version
+	) {
+	}
+}

src/Swagger/Model/License.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace PhpApi\Swagger\Model;
+
+class License
+{
+	public function __construct(public readonly string $name, public readonly string $url)
+	{
+	}
+}

src/Swagger/Model/Path.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace PhpApi\Swagger\Model;
+
+class Path
+{
+    /**
+     *
+     * @param string[] $tags
+     * @param Parameter[] $parameters
+     * @param RequestBody $requestBody
+     * @param array<int, Response> $responses
+     * @return void
+     */
+    public function __construct(
+        public array $tags,
+        public string $summary,
+        public string $description,
+        public string $operationId,
+        public array $parameters,
+        public RequestBody $requestBody,
+        public array $responses,
+    ) {
+    }
+}

src/Swagger/Model/RequestBody.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace PhpApi\Swagger\Model;
+
+class RequestBody
+{
+    /**
+     * @param array<string, ContentType> $content
+     */
+    public function __construct(
+        public string $description,
+        public bool $required,
+        public array $content,
+    ) {
+    }
+}

src/Swagger/Model/Response.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace PhpApi\Swagger\Model;
+
+class Response
+{
+    /**
+     * @param array<string, ResponseContent> $content
+     */
+    public function __construct(
+        public string $description,
+        public array $content,
+    ) {
+    }
+}