Add Rest API metadata event. Added swagger doc (openemr#4817)

In order to make sure that a module REST resource shows up in the FHIR metadata api and to allow us to override service classes in the metadata we needed a new event. Made a change to the fhir readme to explain how to register with swagger.
bradymiller · Jan 11, 2022 · 6b0a815 · 6b0a815
1 parent f8403d6
commit 6b0a815
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 1 deletion.
diff --git a/FHIR_README.md b/FHIR_README.md
@@ -60,6 +60,10 @@ _Example:_ `https://localhost:9300/apis/default/fhir/Patient` returns a Patient'
 
 The Bearer token is required for each OpenEMR FHIR request (except for the Capability Statement), and is conveyed using an Authorization header. Note that the Bearer token is the access_token that is obtained in the [Authorization](API_README.md#authorization) section.
 
+When registering an API client to use with Swagger the following for the redirect url and launch url for the client.
+- Redirect URL -> <base_site_address>/swagger/oauth2-redirect.html
+- Launch URL -> <base_site_address>/swagger/index.html
+
 Request:
 
 ```sh

diff --git a/src/Events/RestApiExtend/RestApiResourceServiceEvent.php b/src/Events/RestApiExtend/RestApiResourceServiceEvent.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace OpenEMR\Events\RestApiExtend;
+
+class RestApiResourceServiceEvent
+{
+    /**
+     * Used whenever the service for a rest api resource needs to be returned for metadata or other kind of resource purposes
+     */
+    const EVENT_HANDLE = 'restapi.service.get';
+
+    /**
+     * @var string The API resource that we need to locate a service for
+     */
+    private $resource;
+
+    /**
+     * @var string The original system resource for service
+     */
+    private $serviceClass;
+
+    public function __construct($resource, $serviceClass)
+    {
+        $this->resource = $resource;
+        $this->serviceClass = $serviceClass;
+    }
+
+    /**
+     * @return string
+     */
+    public function getResource(): string
+    {
+        return $this->resource;
+    }
+
+    /**
+     * @param string $resource
+     * @return RestApiResourceServiceEvent
+     */
+    public function setResource(string $resource): RestApiResourceServiceEvent
+    {
+        $this->resource = $resource;
+        return $this;
+    }
+
+    /**
+     * @return string
+     */
+    public function getServiceClass(): ?string
+    {
+        return $this->serviceClass;
+    }
+
+    /**
+     * @param string $serviceClass
+     * @return RestApiResourceServiceEvent
+     */
+    public function setServiceClass(?string $serviceClass): RestApiResourceServiceEvent
+    {
+        $this->serviceClass = $serviceClass;
+        return $this;
+    }
+}
diff --git a/src/RestControllers/AuthorizationController.php b/src/RestControllers/AuthorizationController.php
@@ -539,7 +539,11 @@ public function oauthAuthorizationFlow(): void
         } catch (OAuthServerException $exception) {
             $this->logger->error(
                 "AuthorizationController->oauthAuthorizationFlow() OAuthServerException",
-                ["hint" => $exception->getHint(), "message" => $exception->getMessage(), 'hint' => $exception->getHint(), 'trace' => $exception->getTraceAsString()]
+                ["hint" => $exception->getHint(), "message" => $exception->getMessage()
+                    , 'payload' => $exception->getPayload()
+                    , 'trace' => $exception->getTraceAsString()
+                    , 'redirectUri' => $exception->getRedirectUri()
+                    , 'errorType' => $exception->getErrorType()]
             );
             SessionUtil::oauthSessionCookieDestroy();
             $this->emitResponse($exception->generateHttpResponse($response));

diff --git a/src/RestControllers/RestControllerHelper.php b/src/RestControllers/RestControllerHelper.php
@@ -13,6 +13,9 @@
 namespace OpenEMR\RestControllers;
 
 use OpenEMR\Common\Logging\SystemLogger;
+use OpenEMR\Events\RestApiExtend\RestApiCreateEvent;
+use OpenEMR\Events\RestApiExtend\RestApiResourceServiceEvent;
+use OpenEMR\Events\RestApiExtend\RestApiScopeEvent;
 use OpenEMR\Services\FHIR\IResourceSearchableService;
 use OpenEMR\Services\Search\FhirSearchParameterDefinition;
 use OpenEMR\Services\Search\SearchFieldType;
@@ -309,9 +312,11 @@ public function getCapabilityRESTObject($routes, $serviceClassNameSpace = self::
             if (!in_array($resource, self::IGNORE_ENDPOINT_RESOURCES)) {
                 $service = null;
                 $serviceClass = $this->getFullyQualifiedServiceClassForResource($resource, $serviceClassNameSpace);
+                $serviceClass = self::filterServiceClassForResource($resource, $serviceClass);
                 if (!empty($serviceClass)) {
                     $service = new $serviceClass();
                 }
+
                 if (!array_key_exists($resource, $resourcesHash)) {
                     $capResource = new FHIRCapabilityStatementResource();
                     $capResource->setType(new FHIRCode($resource));
@@ -336,4 +341,22 @@ public function getCapabilityRESTObject($routes, $serviceClassNameSpace = self::
         }
         return $restItem;
     }
+
+    /**
+     * Fires off a system event for the given API resource to filter the serviceClass.  This gives module writers
+     * the opportunity to extend the api, add / remove Implementation Guide profiles and declare different API conformance
+     * @param $resource The api resource that was parsed
+     * @param $serviceClass The service class that was found by default in the system or null if none was found
+     * @return string|null The filtered service class property
+     */
+    private static function filterServiceClassForResource(string $resource, ?string $serviceClass)
+    {
+        if (!empty($GLOBALS['kernel'])) {
+            $dispatcher = $GLOBALS['kernel']->getEventDispatcher();
+            $event = $dispatcher->dispatch(new RestApiResourceServiceEvent($resource, $serviceClass), RestApiResourceServiceEvent::EVENT_HANDLE);
+            return $event->getServiceClass();
+        }
+
+        return $serviceClass;
+    }
 }