Member 13354156 Ответов: 1

Как преобразовать документ API в виджет


У меня есть эта документация API, и я должен превратить ее в более удобный плагин, такой как виджет.

Как вы это делаете?

Вот пример кода;
Пост /сообщение?ки=[ключ]&ампер;performerId=[ИД]&ампер;кодклиента=[ИД]&ампер;ником=[ник] в HTTP/1.1
Хост: [API]: 80

[сообщение]

Параметры
Имя Обязательное Описание Типа
ключевые строку Yes, поставленный против. Пожалуйста, попросите у нас ваш ключ.
performerId Yes-идентификатор исполнителя, в чьей комнате должен появиться чат.
customerId No integer уникальный идентификатор клиента. Если идентификатор не указан, предполагается, что это незарегистрированный клиент.
Ник Да строка имя, которое этот пользователь будет отображаться как в чате.
post-data Yes string это сообщение, которое клиент хочет сказать комнате (максимум 200 символов).
Пример Ответа
HTTP/1.1 200 OK
Content-Type: text / xml; charset=utf-8
Content-Length: [int]

{
успех: истина / ложь
строка сообщения]
}
Параметры Ответа
Название Описание
успех независимо от того, был ли ваш пост успешным или нет.
сообщение сообщение об ошибке, если успех ложен.



Что я уже пробовал:

У меня есть документация API для различных запросов и ответов, однако они кажутся довольно тонкими в деталях, что заставляет разработчиков тратить много времени на интеграцию. Разве нет способа взять эти документы и создать более удобный плагин или шаблон, который разработчик мог бы легче использовать?

Dave Kreskowiak

Генерировать требования, планировать и писать код? Как еще, по-Вашему, следует ответить на этот вопрос?

Если только ты не спрашиваешь о чем-то, чего я не вижу...

1 Ответов

Рейтинг:
2

David_Wimbley

Если я правильно понимаю ваш вопрос, Ваша проблема заключается в том, что у вас есть документация API, которую трудно читать/понимать и которой не хватает подробностей, но вы хотите преобразовать ее в более удобный для пользователя формат, который поможет разработчикам помочь самим себе?

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

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

Swagger – самый популярный в мире фреймворк для API.[^]

API Blueprint | API Blueprint[^]

Гитхаб - господа/листа: красивые статические документации для API[^]