How it works

Model your data as early as possible and put the Data Flow First approach into action

1 - Model your data

Describe a data model that you can then associate with APIs and messages

Type Modeling

Describe a business model in all its richness (entities, fields, relationships...)

Definition of Facades

To be usable, a type model must be adapted to its context of use (API or message). Akwaype's facades allow you to retain only the necessary types and fields and eventually modify their organization or names

Reuse of facades
Customized properties
Nomenclatures, tags ...
Immediate detection of errors
Image Akwatype Demo 2021 06 05.JPG
Screenshot 2024-02-17 231525.png

2 - Document and share your data model

Use existing reports/extractions or create new ones to share your models with the stakeholders involved in your projects

Develop and test your reports/exports

  • Duplicate, modify existing Akwatype report/extractions ((HTML, plantUML, SQL, JPA...) or create new ones completely adapted to your context.
  • Use all data model metadata, including the custom properties you've added to extend Akwatype's capabilities

Use them in the Data editor and Data Explorer

  • Publish them in the editor and/or graphical explorer for use in the user interface,
  • or download them for any other purpose
Built-in freemarker editor
Full report integration with Data editor and explorer

3 - Model your flows

Describe your services to map your flows and then generate your OpenAPI definitions and graphic representations

API Description

Define your resources and routes to describe your synchronous exchanges. Associate facades to your routes to link them to your data model

Messages description

Define your messages and topics to describe your asynchronous exchanges. Associate facades to your messages to link them to your data model

Full description of flows (exposure and consumption of routes)
Security schemes
Publish / subscribe of messages
Image Akwatype Demo - focus service 2021 06 05.JPG
Swagger editor 2021 06 21-1.jpg

4 - Generate your OpenAPI and AsyncAPI definitions

Leverage the real-time compiled model of your data and flows

OpenAPI generation

Generate your OpenAPI definitions to export the description of your synchronous flows (API) in a standard way
OpenAPI example displayed in Swagger Editor ➔

AsyncAPI generation

Generate your AsyncAPI definitions to export the description of your Asynchronous flows (Events) in a standard way

Instant visualization
Git integration

Akwatype exploration map

Access the documentation of all Akwatype concepts from this interactive map

Akwatype exploration map 2024 1.png

Any questions? We are at your disposal.

Find out how we can help you succeed.
Our solutions allow you to accelerate your projects by taking full advantage of the Data Flow First approach