Skip to main content

3. Framework integration

Dataway runs inside your application, using its web container, login identities and database connections. Select the adapter for your framework and a metadata store, then add SQL support as needed.

Integration options​

Framework adapters register web endpoints and read framework configuration. Each integration guide provides its dependencies and configuration.

Extension modules​

  • dataway-meta-jdbc: Use JDBC to store API definitions, drafts and release history in a database.
  • dataway-meta-nacos: Use Nacos configuration storage to save API definitions, drafts and release history.
  • dataql-sqlproc: Query and update databases through SQL scripts or SQL fragments within DataQL.
  • Custom storage: Implement ApiDataAccessLayer to save API metadata in a storage service of your choice.

Usage guide​

  • Configuration (Spring, Solon, Hasor): Add the modules, register services and enable request endpoints.
  • Access authorization (Spring, Solon, Hasor): Register a login interceptor and provide the current user identity to Dataway.
  • Business data sources (Spring, Solon, Hasor): Supply connections through ConnectionProvider and select one or more data sources by name.
  • SQL transactions (Spring, Solon, Hasor): Use script or host transactions to commit or roll back SQL operations on the same data source together.
  • JDBC examples (Spring, Solon, Hasor): Store metadata in a database and try SQL across two data sources, login, uploads and Swagger UI.
  • Nacos example: Use Spring Boot with Nacos metadata storage. The test entry point starts local Nacos automatically and supports real HTTP tests.