Give it a try #

Make sure your development server is started. We will test a few routes to see how this first feature works on our API.

Creation of the first entities #

Let's make a first call to our API, through Postman or Insomnia for example:

The result is an empty table. This is normal, we have not yet created a single car in the database. So here we go, let's create it.

As you can see, the car has been created (check the status of the response is 201 Created), it has a defined ID and all the information we have passed and respected in relation to our DTO and serialization class.

Now let's try to create another car but forgetting some fields or forcing false fields:

You can see that the status of the response is set to 422 Unprocessable Entity to say that the information passed in the body does not match the DTO. Look carefully at the error details, normally everything is explained.

We invite you to correct your body to create a second car in the database. The best is that the data is not similar to the first one for the continuation of our tests. Try to create several to populate your database. Once this is done, let's try to recover our persistent data:

Great, we created our first entities, with success.

Fetch & update specific entity #

Get the ID of one of your cars, and make the following call to get only the data related to the ID:

You can retrieve the data of a particular car. Now let's try to update it:

We respected the update DTO which is a bit different from the creation DTO and we could update our Car entity. Note that we use the PATCH method to update the entity, unlike the POST method for the creation of an entity.

Now you know how to create, update and fetch entities.

Filter, pagination & other queryparams #

Filter the data #

We will continue our tests using the integrated filter & paging system of the Kodexo CRUD APIs. The filter/pagination system works quite simply, through queryparams of the urls.

To filter, use the keyword in queryparams: $filter followed by a JSON that will contain your query.

When you ask for a particular brand, only the well-sorted data stands out and is given to the response.

You can use several fields in the $filter. You also have several "op" keywords to be more precise in your queries ($or, $and, $not, $ne...). Note that you can chain your queries. See the Filtering in Usage Guide for more information.

Pagination #

With Kodexo CRUD, you can use offset pagination.

Only 2 keywords to put in your queryparams: $limit and $offset. The behavior is the same as any offset pagination: you pass the number of results you want per page in the $limit parameter and the number of entities you want to skip on the $offset parameter.

Congratulations, you have completed the tutorial. Don't hesitate to browse the documentation to go further, there are many other principles to understand, to master Kodexo and simplify your developments.