Q&A
Common questions and answers about using EasyYapi.
Configuration
- How to add config file — Adding configuration files to your project
API Organization
- How to group APIs to folder — Organizing APIs into folders
- How to ignore API — Excluding APIs from documentation
- How to set API/folder name/description — Customizing API names and descriptions
- How to mark API as deprecated — Marking APIs as deprecated
Permissions
- How to declare API permission (javax) — Using javax.annotation.security
- How to declare API permission (Spring) — Using Spring Security
Fields & Types
- How to ignore fields — Excluding fields from documentation
- How to convert type — Converting one type to another
- Multiple return types — Handling APIs with different return types
- Field with multiple types — Handling fields with multiple possible types
Validation
- Enable javax.validation groups — Using validation groups
- Activate JsonIgnoreProperties — Jackson JsonIgnoreProperties support
Troubleshooting
- Complex class blocked — Resolving "too complex" errors