Documentation
Microservices, components and messages can be documented using Markdown. These descriptions make components more maintainable and usable, being accessible through the descriptive builtin services and visible in the functional testing module.
Each microservice can be documented via a brutusin-rpc.md file to be loaded by the classloader in the root namespace.
Actions and topics can be documented by different means:
- By annotating the class with
@Description - By making the class implement the interface
Descriptible
Input and output messages can be documented using @JsonProperty
- Home
- Getting started
- Services
- HTTP services
- Messaging topics
- Spring
- Documenting
- Referencing source code
- Builtin components
- Configuration
- Deployment
- Client APIs
- Security
- Developer notes
- Architecture
- Examples