Документация REST API

Mini web-сервер для печати чеков на фискальных регистраторах из мобильных приложений через HTTP запрос JSON.
Ответить
janealter
Сообщения: 16
Зарегистрирован: 14 янв 2021, 22:15

Документация REST API

Сообщение janealter » 21 янв 2021, 20:05

Привет всем, и особенно Audim! Далее будет вопрос к вам. Не нашел никакой документации REST API на сайте, только примеры на JS. В наше время это как-то совсем несерьезно, все-таки вы предоставляете веб-сервер, к тому же небесплатный. В таком случае, он должен обладать нормальной документацией (например, по спецификации Swagger/OpenAPI), а не примерами кода, в которых надо еще выискивать глазами непосредственно сами запросы. Это крайне неудобно. Документация планируется вообще когда-нибудь? Или может она есть, но не в публичном доступе?

avk1973
Сообщения: 37
Зарегистрирован: 07 мар 2019, 15:52

Re: Документация REST API

Сообщение avk1973 » 22 янв 2021, 14:49

Добрый день.
Там всё общение идёт по JSON и подробно разобрано на примерах, запросы уходят через обычный cgi-post протокол.
JSON насколько я понимаю во всех языках одинаков, поэтому особой разницы между хорошо прокомментированными примерами на js и формальным описанием api как бы и не вижу.

Программа стоит очень недорого по сравнению с остальными продуктами в этой тематике, поэтому большой вопрос- стоит ли доводить её до большого проекта по другой цене...

janealter
Сообщения: 16
Зарегистрирован: 14 янв 2021, 22:15

Re: Документация REST API

Сообщение janealter » 22 янв 2021, 20:33

В общем-то неважно, маленькая программа, или большая. В любом случае, считать примеры кода нормальной документацией - это очень странно с вашей стороны, пускай даже эти примеры и снабжены кривоватыми комментариями (которые еще и одного цвета с кодом). Или, может, вам просто нравится тратить время на скроллинг ненужного кода, чтобы добраться непосредственно до JSON запроса и ответа :) В наше время даже бесплатные библиотеки обладают и примерами, и документацией. Не думаю, что создание документации займет много времени (есть и автогенерация в том числе), зато инженерам сильно упростит жизнь. Можно заплатить чуть больше ради удобства, но если вам нравится работать с платным закрытым ПО, которое задокументировано на уровне плагина для JQuery, написанного школьником в 90-е, то у меня никаких вопросов к вам ;)
Последний раз редактировалось janealter 22 янв 2021, 20:46, всего редактировалось 1 раз.

janealter
Сообщения: 16
Зарегистрирован: 14 янв 2021, 22:15

Re: Документация REST API

Сообщение janealter » 22 янв 2021, 20:42

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

surnin
Сообщения: 1
Зарегистрирован: 16 июн 2021, 18:13

Re: Документация REST API

Сообщение surnin » 16 июн 2021, 18:16

Тоже зашел сюда в надежде найти описание api но оказывается его нет :(
Быть может напишите?

Аватара пользователя
saratovout
Сообщения: 227
Зарегистрирован: 08 авг 2019, 23:52
Откуда: Boston
Контактная информация:

Re: Документация REST API

Сообщение saratovout » 16 июн 2021, 20:58

surnin писал(а):
16 июн 2021, 18:16
Тоже зашел сюда в надежде найти описание api но оказывается его нет :(
Быть может напишите?
Скачайте дистрибутив, в папке есть все примеры.
Другого ждать не стоит.
Последний раз редактировалось saratovout 26 июн 2021, 13:33, всего редактировалось 1 раз.
good films make your life better..

Аватара пользователя
Вторник
Сообщения: 228
Зарегистрирован: 16 май 2017, 08:36

Re: Документация REST API

Сообщение Вторник » 26 июн 2021, 13:25

saratovout писал(а):
16 июн 2021, 20:58
Скачайте дистрибутив, в папке есть все примеры.
Бог терпел и нам велел.

Документация, когда она есть, выглядит примерно так - https://petstore.swagger.io/.

У KkmServer документации нет и никогда не было. Увы.

Ответить