Приемы описания документации API используя нотацию RAML

0. 708 24.06.20 10:55 Сейчас в теме
В статье опишу приемы, которые использую в своей работе, и которые позволяют быстро реализовать описание.

Перейти к публикации

Комментарии
В избранное Подписаться на ответы Сортировка: Древо развёрнутое
Свернуть все
1. Steelvan 102 24.06.20 13:14 Сейчас в теме
Все эти технические форматы далеки от обычного человекочитаемого восприятия.

Вот например два похожих продукта (компонента для веб-гнезд) от разных разработчиков.

Бесплатная libwebsockets
https://libwebsockets.org/lws-api-doc-v4.0-stable/html/modules.html

Платная
https://cdn.nsoftware.com/help/IWF/bcb/

---

Да я лучше 30 000 заплачу сверху, но зато получу нормальную человекочитаемую доку.
Разбираться в бесплатном варианте буду дольше, чем эту 30-ку заработаю => время деньги.
2. malikov_pro 708 24.06.20 13:24 Сейчас в теме
(1) В итогах показал внешний вид для "обычного человекочитаемого восприятия", конвертация делается утилитой через командную строку (у меня в проектах bat файлы для этого).
Примеры
https://www.sima-land.ru/api/v3/help
https://api.samsonopt.ru/v1/doc/index.html#api-v1-0-0
сформированы из OpenAPI (swagger).

Подобное можно формировать и из RAML https://docs.api-console.io/

У вас в примере WebSocket, у меня HTTP, разные протоколы и инструменты описания.
Оставьте свое сообщение
Вопросы с вознаграждением
Вакансии
Архитектор 1С
Пермь
зарплата до 200 000 руб.
Полный день

Бизнес-аналитик 1С
Санкт-Петербург
зарплата от 120 000 руб. до 150 000 руб.
Полный день

Бизнес-аналитик 1С
Пермь
зарплата до 100 000 руб.
Полный день

Старший программист 1С
Самара
зарплата от 70 000 руб.
Полный день

Программист, аналитик, эксперт 1С
Санкт-Петербург
По совместительству