🆔Entities
Entities are the core building blocks of your APIs in API Builder. They represent data models that your API will manage, akin to tables in a database. Defining entities allows API Builder to generate
Last updated
Entities are the core building blocks of your APIs in API Builder. They represent data models that your API will manage, akin to tables in a database. Defining entities allows API Builder to generate
Last updated
The database structure is delineated through an Entity-Relationship Diagram (ERD). The Entity-Relationship (ER) Model encompasses entities, the properties within these entities, and the relationships among them, thereby mapping the relationships within the project's domain area. The domain area effectively mirrors real-world processes and interactions.
Every entity has an attribute and an action over the entity. In API Builder we use term property for attribute.
Instances are documented within the database, and constraints can be applied to properties to govern the characteristics of future instances. Within this context, "entities" correlate with database tables, whereas "properties" are synonymous with the fields of these tables.
Validation : Entities names are written in singular form, with CamelCase and starts with a capital letter.
How to create an entity
Access the Project Dashboard: Log in to API Builder and open the project in which you want to create a new entity.
Locate the Entity Addition Icon: On the project dashboard, direct your attention to the navigation menu on the left side of the screen. Look for the "Entities" section, which lists all the current entities in your project.
Initiate Entity Creation: Within the "Entities" section, you'll notice a "+" sign or an icon indicating the option to add a new entity. Click this icon to begin the process of creating a new entity.
Fill Out the Entity Form: Upon clicking the "+" sign, a form will appear prompting you to provide details for the new entity. The primary detail required at this stage is the "Entity Name".
Entity Name: Enter a name for your new entity, adhering to the validation rules specified by API Builder. These rules often include guidelines on acceptable characters, the use of uppercase or lowercase letters, and avoiding certain reserved words. The entity name should be descriptive of the data model the entity represents, making it easily identifiable within your project.
Submit the Form: After entering the entity name and ensuring it complies with the validation rules, proceed to submit the form. By clicking on add button.
