feat: improve response of create/update APIs

Author: freemindcore

easy/controller/meta.py

@@ -4,7 +4,7 @@
 import uuid
 from abc import ABC, ABCMeta
 from collections import ChainMap
-from typing import Any, Match, Optional, Tuple, Type
+from typing import Any, List, Match, Optional, Tuple, Type
 
 from django.http import HttpRequest
 from ninja import ModelSchema
@@ -109,18 +109,18 @@ async def get_objs(self, request: HttpRequest, filters: str = None) -> Any:  # t
             class DataSchema(ModelSchema):
                 class Config:
                     model = model_opts.model
-                    model_exclude = []
+                    model_exclude: List = []
                     if model_opts.model_exclude:
                         model_exclude.extend(model_opts.model_exclude)
                         # Remove pk(id) from Create/Update Schema
-                        model_exclude.extend([model._meta.pk.name])
+                        model_exclude.extend([model._meta.pk.name])  # type: ignore
                     else:
                         if model_opts.model_fields == MODEL_FIELDS_ATTR_DEFAULT:
                             # Remove pk(id) from Create/Update Schema
-                            model_exclude.extend([model._meta.pk.name])
+                            model_exclude.extend([model._meta.pk.name])  # type: ignore
                         else:
                             model_fields = (
-                                model_opts.model_fields  # type: ignore
+                                model_opts.model_fields
                                 if model_opts.model_fields
                                 else MODEL_FIELDS_ATTR_DEFAULT
                             )
@@ -134,9 +134,11 @@ async def add_obj(  # type: ignore
                 """
                 obj_id = await self.service.add_obj(**data.dict())
                 if obj_id:
-                    return BaseApiResponse({"id": obj_id}, code=201)
+                    return BaseApiResponse({"id": obj_id}, code=201, message="Created.")
                 else:
-                    return BaseApiResponse("Add failed", code=204)  # pragma: no cover
+                    return BaseApiResponse(
+                        code=204, message="Add failed."
+                    )  # pragma: no cover
 
             async def patch_obj(  # type: ignore
                 self, request: HttpRequest, id: int, data: DataSchema
@@ -146,9 +148,9 @@ async def patch_obj(  # type: ignore
                 Update a single object
                 """
                 if await self.service.patch_obj(id=id, payload=data.dict()):
-                    return BaseApiResponse("Updated.")
+                    return BaseApiResponse(message="Updated.")
                 else:
-                    return BaseApiResponse("Update Failed", code=400)
+                    return BaseApiResponse(code=400, message="Updated Failed")
 
             DataSchema.__name__ = (
                 f"{model_opts.model.__name__}__AutoSchema({str(uuid.uuid4())[:4]})"

easy/response.py

@@ -6,9 +6,8 @@
 
 from easy.renderer.json import EasyJSONEncoder
 
-ERRNO_SUCCESS = 0
+CODE_SUCCESS = 0
 SUCCESS_MESSAGE = "success"
-UNKNOWN_ERROR_MSG = "system error"
 
 
 class BaseApiResponse(JsonResponse):
@@ -24,10 +23,10 @@ def __init__(
         **kwargs: Any
     ):
         if code:
-            message = message or UNKNOWN_ERROR_MSG
+            message = message or str(code)
         else:
-            message = SUCCESS_MESSAGE
-            code = ERRNO_SUCCESS
+            message = message or SUCCESS_MESSAGE
+            code = CODE_SUCCESS
 
         _data: Union[Dict, str] = {
             "code": code,

tests/test_async_api_permissions.py

@@ -192,7 +192,7 @@ async def test_perm_auto_apis_patch(self, transactional_db, easy_api_client):
         response = await client.patch(
             f"/{event.id}", json=new_data, content_type="application/json"
         )
-        assert response.json().get("data")
+        assert response.json().get("message") == "Updated."
 
         response = await client.get(
             f"/{event.id}",

tests/test_async_auto_crud_apis.py

@@ -193,8 +193,9 @@ async def test_crud_default_create(self, transactional_db, easy_api_client):
             "/", json=object_data, content_type="application/json"
         )
         assert response.status_code == 200
-
         assert response.json().get("code") == 201
+        assert response.json().get("message") == "Created."
+
         event_id = response.json().get("data")["id"]
 
         response = await client.get(
@@ -276,7 +277,7 @@ async def test_crud_default_patch(self, transactional_db, easy_api_client):
         )
 
         assert response.status_code == 200
-        assert response.json().get("data")
+        assert response.json().get("message") == "Updated."
 
         response = await client.get(
             f"/{event.pk}",