Introduced Interface for ServiceEndpoints

Author: mgerzabek

src/Endpoint.php

@@ -2,21 +2,14 @@
 
 namespace Flat3\Lodata;
 
-class Endpoint
+use Flat3\Lodata\Interfaces\ServiceEndpointInterface;
+
+class Endpoint implements ServiceEndpointInterface
 {
-    /**
-     * @var string $serviceUri the &lt;service-uri> of the <code>Flat3\Lodata\Model</code>.
-     */
     protected $serviceUri;
 
-    /**
-     * @var string $route the route prefix configured in <code>'lodata.prefix'</code>
-     */
     protected $route;
 
-    /**
-     * @var string $endpoint the full url to the ODataService endpoint
-     */
     protected $endpoint;
 
     public function __construct(string $serviceUri)
@@ -31,10 +24,6 @@ public function __construct(string $serviceUri)
         $this->endpoint = url($this->route) . '/';
     }
 
-    /**
-     * @return string the path within the odata URI space, like in
-     * https://<server>:<port>/<config('lodata.prefix')>/<service-uri>/$metadata
-     */
     public function endpoint(): string
     {
         return $this->endpoint;
@@ -45,29 +34,18 @@ public function route(): string
         return $this->route;
     }
 
-    /**
-     * This method is intended to be overridden by subclasses.
-     *
-     * The value of the function will be presented in the Schema Namespace attribute,
-     * https://docs.oasis-open.org/odata/odata-csdl-xml/v4.01/odata-csdl-xml-v4.01.html#sec_Schema
-     *
-     * @return string
-     */
-    public function getNamespace(): string
+    public function namespace(): string
     {
-        // override this function to set Schema Namespace attribute
         return config('lodata.namespace');
     }
 
-    /**
-     * This method is intended to be overridden by subclasses.
-     *
-     * Discovers Schema and Annotations of the `$metadata` file for
-     * the service.
-     */
+    public function cachedMetadataXMLPath(): ?string
+    {
+        return null;
+    }
+
     public function discover(Model $model): Model
     {
-        // override this function to register all of your $metadata capabilities
         return $model;
     }
 }

src/Interfaces/ServiceEndpointInterface.php

@@ -5,68 +5,33 @@
 use Flat3\Lodata\Model;
 
 /**
- * Interface for defining a modular OData service endpoint in Laravel.
+ * Interface for defining a custom OData service endpoint.
  *
- * Implementers of this interface represent individually addressable OData services.
- * Each mounted under its own URI segment and backed by a schema model.
- *
- * This enables clean separation of business domains and supports multi-endpoint
- * discovery for modular application design.
- *
- * Configuration versus Declaration
- * --------------------------------
- * The public URI segment used to expose a service is NOT determined by the
- * implementing class itself, but by the service map in `config/lodata.php`:
- *
- * ```php
- *   'endpoints' => [
- *       'users' => \App\OData\UsersEndpoint::class,
- *       'budgets' => \App\OData\BudgetsEndpoint::class,
- *   ]
- * ```
- *
- * This keeps the routing surface under application control, and avoids
- * conflicts when two modules declare the same internal segment.
- *
- * To implement an endpoint:
- *   - Extend `Flat3\Lodata\Endpoint` or implement this interface directly
- *   - Register the class in `config/lodata.php` under a unique segment key
- *   - Define the `discover()` method to expose entities via OData
+ * Implementers can use this interface to expose a specific service under a custom path,
+ * define its namespace, route behavior, and optionally provide a statically generated
+ * $metadata document.
  */
 interface ServiceEndpointInterface
 {
-    /**
-     * Returns the ServiceURI segment name for this OData endpoint.
-     *
-     * This value is used in routing and metadata resolution. It Must be globally unique.
-     *
-     * @return string The segment (path identifier) of the endpoint
-     */
-    public function serviceUri(): string;
 
     /**
-     * Returns the fully qualified URL for this OData endpoint.
+     * Returns the relative endpoint identifier within the OData service URI space.
      *
-     *  This includes the application host, port, and the configured segment,
-     *  https://<server>:<port>/<config('lodata.prefix')>/<service-uri>/,
-     *  Example: https://example.com/odata/users/
+     * This is the part that appears between the configured Lodata prefix and
+     * the `$metadata` segment, e.g.:
+     *   https://<server>:<port>/<config('lodata.prefix')>/<endpoint>/$metadata
      *
-     * This URL forms the base of the OData service space, and is used for navigation links
-     * and metadata discovery.
-     *
-     * @return string The full URL of the service endpoint
+     * @return string The relative OData endpoint path
      */
     public function endpoint(): string;
 
     /**
-     * Returns the internal Laravel route path for this OData service endpoint.
-     *
-     * This is the relative URI path that Laravel uses to match incoming requests,
-     * typically composed of the configured Lodata prefix and the service segment.
+     * Returns the full request route to this service endpoint.
      *
-     * Example: "odata/users"
+     * This typically resolves to the route path used by Laravel to handle
+     * incoming requests for this specific service instance.
      *
-     * @return string Relative route path for the endpoint
+     * @return string The full HTTP route to the endpoint
      */
     public function route(): string;
 

src/Model.php

@@ -199,7 +199,7 @@ public function getTypeDefinition(string $name): ?Type
      */
     public static function getNamespace(): string
     {
-        return app(Endpoint::class)->getNamespace();
+        return app(Endpoint::class)->namespace();
     }
 
     /**