Полезно ли добавлять новые параметры в запрос API json для тестирования автоматизации API?

Question

Например: у меня есть POST API с json-запросом, как показано ниже

{
    "items":[
      {
        "name": "abc",
        "gender": "female",
        "companyName": "test"
      }
    ]
  }

Теперь я хотел бы добавить новое поле с именем comment, чтобы указать, для чего тестирует json-запрос?что-то вроде этого

{
    "comment": "test employee with name",
    "items":[
      {
        "name": "abc",
        "gender": "female",
        "companyName": "test"
      }
    ]
  }

Является ли хорошей практикой добавление / изменение параметров для целей тестирования в запросе json?Если нет, каковы другие способы сделать это?Я использую TestNG, RestAssured и JAVA для тестирования автоматизации API

Answer 1

Это даже не будет работать, так как схема json для полезной нагрузки будет изменена, если вы добавите другой атрибут.Это бросит вам исключение.

Если вы хотите добавить описание, вы можете добавить его в свои тесты.Вы можете достичь этого в testng, добавив атрибут description в аннотацию @Test.

@Test(description = "This a new test", dependsOnMethods = "test1")
public void test2(){
     ...
}