Axon Framework Reference Documentation

Welcome to the Axon Framework’s reference documentation. It provides information about the modules and components of the framework, their purpose, and their intended use.

Prerequisite knowledge

Axon Framework helps software developers build solutions according to specific software development concepts. While not strictly required, knowing those concepts makes it much easier to understand the framework’s principles and the architectural decisions behind it. If you are new to DDD, CQRS, or Event Sourcing, consider reading the "Software Development Concepts" first.

Axon Framework alone significantly simplifies the software development process of JVM-based applications following the above principles. However, it adds even more value when used in combination with other products of the Axon family. To understand the bigger picture, please refer to "Understanding Axon". It explains how individual products complement each other and work together towards a common goal.

The reference documentation is a valuable source during the development process. It assumes the reader is familiar with the underlying software design principles, deployment architectures, etc. To learn more about those, please refer to the relevant Explanations. For step-by-step instructions and examples of how to build Axon-based applications, use the Tutorials. For solving known challenges and completing typical tasks, there are How-To Guides.

Reference documentation structure

The reference documentation aims to document the specifics of the framework’s functionality, objects, interfaces, etc. It’s a convenient, quick-access reference answering questions like "What’s X?", "What’s X used for?", "How’s X implemented?" etc. Thus it closely follows the structure of Axon Framework’s source code. Such an approach makes it easier to quickly navigate to any specific element.

License

Axon Framework is open source and provided under the Apache License v2.0.