schema
About 120 wordsLess than 1 minute
Tips
When having AI generate request/response models, first reference fba skills to keep SchemaBase, Field(description=...), optional update fields, and camelCase response conventions consistent.
In fba, Schema has been heavily customized. See: backend\common\schema.py
Class Naming
Follow these naming conventions:
- Base schema:
XxxSchemaBase(SchemaBase) - API request params:
XxxParam() - Create params:
CreateXxxParam() - Update params:
UpdateXxxParam() - Batch delete params:
DeleteXxxParam() - Detail query:
GetXxxDetail() - Detail query (join):
GetXxxWithJoinDetail() - Detail query (relationship):
GetXxxWithRelationDetail() - Tree query:
GetXxxTree()
Field Definitions
- Do not set required field defaults to
.... See: Required fields - Add a
descriptionparameter to every field — it is very useful for API documentation