Какие есть best practises при документировании взаимодействия frontend-backend?

Question

[Vetal Matitskiy]

Добрый день, в проекте бекенд-девелопер хочет получить запросы которые будут отсылатся с фронта и ответ от бекенда. но толком что ему нужно объяснить видимо не способен, или же не хочет. подскажите пожалуйста есть ли какие-то стандартные практики каким образом лучше документировать эти вещи и как это оформлять
единственно что удалось выбить пока это пример запроса

form_data = $("#your_form").serialize();
$.post("/_ajax.php", {token: $('#f_token').attr("content"), file: 'constructor', 
data: 
 {
    items: ['CO037EWIRW04IN', 'CO037EWILA28IN']
	tags: {id:1; id:2; }
	sex:1
	type_body:1
	color: 4
	category:6
}
}, function(r) {
           try {
               result = jQuery.parseJSON(r);
           } catch(err){
               alert(err);
           }
           if (result.status == "success") {
               alert(result.mes);
           } else {
               alert(result.mes);
           }
});

Answer 1

[Михаил Рыбаков]

Есть такие вещи как Swagger, RAML с помощью которых можно документировать API: описать маршруты, параметры, структуры данных и пр. На основе этого и можно строить взаимодействие. А вообще это вы (frontend-разработчик, как я понимаю) должны сказать, что вам нужно, какие данные и в каком формате хотите получать.

Comments

[Vetal Matitskiy]

ну вот в деталях как раз и вопрос. с форматом вроде определились - json, а весь вопрос как указать какие конкретно данные

[Михаил Рыбаков]

Vetal Matitskiy: ну вот, например на RAML пример как можно описать структуру данных https://github.com/raml-org/raml-spec/blob/master/...
А что конкретно передавать это уже вам решать, исходя из поставленной задачи.