VadimCpp/API.md

## API.md

      
    Raw
  

              API.md
            
          
    Название метода

<Описание метода API. Тут стоит написать, что делает метод.>


URL
<Собственно запрос>


Метод
<Тип запроса>
GET | POST | DELETE | PUT


Параметры URL
<Если в запросе передаются параметры, указать их в той же последовательности, в которой они следуют в URL. Раздельно описать обязательные и опциональные(необязательные) параметры. Также стоит указать ограничения.>
Обязательные
id=[integer]
Опциональные
photo_id=[alphanumeric]


Данные
<Если выполнятся post запрос, что тогда будет в теле запроса?>


Успешный ответ
<Какой будет код ответа и что должен вернуть сервер в случае успеха? Разработчикам полезно знать какие данные ожидать от сервера в callback функции!>

Код: 200 OK

Дата:
{  id : 12  }


Ответ ошибки
<В большинстве случаев существует много разных вариантов ошибок. Отсутствие доступа, неверные параметры и т.д. Все возможные варианты ошибок должны быть описаны здесь. Может показаться излишним описывать все варианты, но это убережет разработчика от ненужных догадок.>

Код: 401 UNAUTHORIZED 

Дата: { error : "Неверный логин или пароль" }

ИЛИ

Код: 422 UNPROCESSABLE ENTRY 

Дата: { error : "Неверный адрес электронной почты" }


Пример вызова
<Разместить пример вызова в удобном для запуска формате (например, $.ajax или curl запрос) - это облегчит всем жизнь.>


Заметки
<В этом разделе оставлять комментарии, замечания, вопросы и т.д. Рекомендуется к каждому к комментарию добавлять время написания и автора.>


## EXAMPLE.md

      
    Raw
  

              EXAMPLE.md
            
          
    Проверка орфографии

Возвращает HTML текст, в котором подсвечены все слова с орфографическими ошибками


URL
/orfograf/result/


Метод
POST


Параметры URL
Нет


Данные
В теле запроса передается текст для проверки и его формат

Дата:
{ SearchFieldExValue: 'Найдите орфографические ошибки и исправьте их! Прожёрливый мальчонка решил полакомиться вкустным борщом, копчоной рыбкой, тушеной печонкой и запить все эти вкустности чаем со сгушенным молоком . Чтобы подогреть борщ, он зажог плиту и при этом обжег себе руку кострюлей. "Вот чорт,- воскликнул он,- как горячо"', SearchFieldValue: '', type: 3, orfomode: 'text' }

ИЛИ

Дата:
{ SearchFieldExValue: '', SearchFieldValue: 'tema.ru', type: 3, orfomode: 'url' }


Успешный ответ
В случае успеха запрос возвращает НTML страницу с результатом

Код: 200 OK

Дата:
<body onload='if(top.ArlLebedevToolsOrfoResult) top.ArlLebedevToolsOrfoResult("","http://")'><base href="http://" /><style type="text/css">span.misspelt {background-color: #FFF21E; color: #000000}</style>Найдите орфографические ошибки и исправьте их! <span class="misspelt">Прожёрливый</span> мальчонка решил полакомиться <span class="misspelt">вкустным</span> борщом, <span class="misspelt">копчоной</span> рыбкой, тушеной <span class="misspelt">печонкой</span> и запить все эти <span class="misspelt">вкустности</span> чаем со <span class="misspelt">сгушенным</span> молоком . Чтобы подогреть борщ, он <span class="misspelt">зажог</span> плиту и при этом обжег себе руку <span class="misspelt">кострюлей</span>. "Вот <span class="misspelt">чорт</span>,- воскликнул он,- как горячо"


Ответ ошибки
Запрос всегда возвращает код 200 ОК. В случае ошибки возвращается пустая страница.


Пример вызова
Открыть страницу https://www.artlebedev.ru/orfograf/ и в окне консоли выполнить запрос:
$.ajax({
    url: 'https://www.artlebedev.ru/orfograf/result/',
    type: 'POST',
    data: {
        SearchFieldExValue: 'Найдите орфографические ошибки и исправьте их! Прожёрливый мальчонка решил полакомиться вкустным борщом, копчоной рыбкой, тушеной печонкой и запить все эти вкустности чаем со сгушенным молоком . Чтобы подогреть борщ, он зажог плиту и при этом обжег себе руку кострюлей. "Вот чорт,- воскликнул он,- как горячо"',
        SearchFieldValue: '',
        type: 3,
        orfomode: 'text'
    }
});


Заметки
Принимаются предложения по улучшению примера. 2018-05-19 Vadim Cpp