functional framework service

.gitignore

@@ -1,5 +1,6 @@
 composer.phar
 /vendor/
+composer.lock
 
 # Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
 # You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file

composer.json

@@ -0,0 +1,14 @@
+{
+	"name": "gcgov/framework-service-documentation",
+	"type": "framework-service",
+	"description": "Plugin that enables a route to generate OpenAPI yaml documentation at the /documentation.yaml route",
+	"license": "MIT",
+	"autoload": {
+		"psr-4": {
+			"gcgov\\framework\\services\\documentation\\": "src/"
+		}
+	},
+	"require": {
+		"php": ">=8.1"
+	}
+}

src/controllers/documentation.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace gcgov\framework\services\documentation\controllers;
+
+use gcgov\framework\config;
+use gcgov\framework\interfaces\controller;
+use gcgov\framework\models\controllerDataResponse;
+use JetBrains\PhpStorm\NoReturn;
+
+class documentation implements controller {
+
+	public function __construct() {
+
+	}
+
+
+	#[NoReturn]
+	public function yaml(): void {
+		$openapi = \OpenApi\Generator::scan( [ config::getRootDir() . '/app', config::getRootDir() . '/vendor/gcgov/framework/src/controllers', config::getRootDir() . '/vendor/gcgov/framework/src/exceptions', config::getRootDir() . '/vendor/gcgov/framework/src/models', config::getRootDir() . '/vendor/gcgov/framework/src/services' ], [ 'exclude' => [ 'vendor' ] ] );
+		header( 'Content-Type: text/x-yaml' );
+		echo $openapi->toYaml();
+		die();
+	}
+
+
+	public function routes(): controllerDataResponse {
+		$routes = [];
+		return new controllerDataResponse( $routes );
+	}
+
+
+	/**
+	 * Processed after lifecycle is complete with this instance
+	 */
+	public static function _after(): void {
+	}
+
+
+	/**
+	 * Processed prior to __constructor() being called
+	 */
+	public static function _before(): void {
+	}
+
+}

src/router.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace gcgov\framework\services\documentation;
+
+use gcgov\framework\config;
+use gcgov\framework\models\route;
+
+class router
+	implements
+	\gcgov\framework\interfaces\router {
+
+	public function getRoutes(): array {
+		return [
+			new route( 'GET', config::getEnvironmentConfig()->getBasePath() . '/documentation.yaml', '\gcgov\framework\services\documentation\controllers\documentation', 'yaml', false )
+		];
+	}
+
+
+	public function authentication( \gcgov\framework\models\routeHandler $routeHandler ): bool {
+		return false;
+	}
+
+
+	/**
+	 * Processed after lifecycle is complete with this instance
+	 */
+	public static function _after(): void {
+	}
+
+
+	/**
+	 * Processed prior to __constructor() being called
+	 */
+	public static function _before(): void {
+	}
+
+}