Custom REST APIs in Gravitino

[adwaithadwaith]

Hi guys,
I’m exploring ways to extend Gravitino and wanted to ask about adding custom REST APIs.
Is there a way to implement custom APIs in a separate module or JAR And have Gravitino load them via configuration, without changing or forking the server code?
If that’s not possible today, is there any plan for a plugin-style extension mechanism, or is the expected approach to modify the Gravitino server ?

Thanks in advance!

[bharos]

When I check the configs, I do see this option:
gravitino.server.rest.extensionPackages
documented in https://gravitino.apache.org/docs/1.1.0/gravitino-server-config/#apache-gravitino-http-server-configuration

So I guess this is possible already, something like:

To add custom REST APIs:

1. Create a JAR with your custom APIs:
   @Path("/api/v1/custom")
   public class MyCustomAPI {
       @GET
       public Response myEndpoint() { ... }
   }

2. Place the JAR in Gravitino's classpath (e.g., libs/)

3. Configure gravitino.conf:
   gravitino.server.rest.extensionPackages = com.mycompany.gravitino.custom

4. Restart Gravitino

I guess that's what you're trying to do @adwaithadwaith ?

[adwaithadwaith]

Thank you. This is exactly what I was looking for.

[adwaithadwaith]

Hi @bharos Is there a way to add custom catalogs through the custom package. The custom catalog maybe of new type

[bharos]

That's a good question. Custom catalogs are more complex than custom REST APIs.

For a custom catalog of a new type, you'd need to:

1. Implement the catalog interface (BaseCatalog, CatalogOperations, etc.)
2. Extend the storage layer to persist your catalog's metadata
3. Potentially modify core components for entity management

Currently, Gravitino's extension mechanism (gravitino.server.rest.extensionPackages) is designed for adding REST endpoints, not entire catalog implementations. Custom catalogs typically require deeper integration.

What specific catalog type are you looking to add? If it's a standard system (e.g., a new database or lake format), I'd recommend opening a feature request so the community can discuss adding native support. If it's highly specialized, you might need to fork or contribute a plugin system enhancement.

[FANNG1]

Gravitino Iceberg REST server supports a custom catalog backend by https://gravitino.apache.org/docs/1.1.0/iceberg-rest-service#custom-backend-configuration, but it seems not related to custom REST APIs