dox_annotation

Annotations and interfaces that the Dox packages share.

Part of Dox, a web backend framework for Dart, like Laravel. Source code: github.com/dartondox/dox.

How it is used

You do not add this package yourself. dox_core and dox_orm export it, so the names are already there when you import them.

It holds:

• @DoxModel() for models.
• @DoxEnv() and @EnvKey('X') for the typed env class.
• OpenAPI annotations: @Summary, @Description, @Tags, @Request, @Body, @Query, @Response, @ApiDeprecated, @ApiIgnore, @DoxController.
• Small interfaces that let the packages work together, like IDoxRequest, IDoxMiddleware and IAuth.

The DTO annotations (@Dto, @Length, @Email, ...) are in dox_validation.

Dox 3.x is in alpha (3.0.0-alpha.x).

Documentation

• OpenAPI annotations
• Models
• API reference

License

MIT. See LICENSE.