Connect with us

API

Theneo — создание документации для API

Theneo анализирует API, разбирает его, а затем возвращает уже хорошо структурированный документ.

Опубликовано

/

     
     

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

Рынок управления API в настоящее время составляет 4.5 миллиарда долларов — и эта цифра, по прогнозам, вырастет почти до 14 миллиардов долларов в течение пяти лет. Так что работа в этой области достаточно перспективна. Ведь недостаточно просто создать API — его функции, функциональные возможности и инструкции по развертыванию необходимо записать и представить в удобном для восприятия формате. Правильная документация API является обязательным условием, и именно здесь Theneo надеется получить свою долю рынка.

Соучредитель и генеральный директор Theneo Ана Робакидзе сказала, что она работала над сотнями API на предыдущей должности, возглавляя команду инженеров, и пришла к выводу, что качественной документации по API часто не хватает.

«Я лично был свидетелем того, как документация по API влияла на реализацию, стоимость и эффективность нашего проекта», — сказал Робакидзе. «В результате, как руководитель группы, я потратил значительное количество времени и усилий на поиск инструмента, который помог бы нам в создании отличной документации по API — аналогично тому, что есть у Stripe, поскольку он считается одним из лучших в отрасли. Проблема с большинством инструментов заключается в том, что они либо отнимали много времени, либо имели слишком много ограничений».

“Одна из причин, по которой мне нравится работать над интеграцией Stripe, заключается в том, что их документация по API очень хорошо организована, имеет очень продуманный пользовательский интерфейс и, как правило, упрощает получение разработчиками информации, необходимой для интеграции с ними», — сказала Робакидзе. “Когда я работала над другими альтернативами Stripe, это часто занимало у меня в два раза больше времени из-за того, насколько сложно было просматривать и находить необходимую информацию об API. Разработчики обожают документацию API Stripe, поэтому мы хотели убедиться, что другие компании и разработчики могут создавать такую ​​же высококачественную документацию”.

Корень проблемы, по словам Робакидзе, в том, что разработчики не обязательно являются техническими писателями — они скорее «создадут еще один API, чем задокументируют этот». Следовательно, многие внутренние API-интерфейсы (например, API-интерфейсы, созданные для подключения внутренних систем и приложений компании) либо полностью недокументированы, либо, если они документированы, не поддерживаются по мере развития API. Эта проблема усугубляется по мере того, как разработчики приходят и уходят из компании, что часто приводит к хаосу.

«Theneo был создан из-за разочарования, с целью сделать создание высококачественной документации по API быстрым и простым», — говорит Робакидзе.

С помощью Theneo разработчики подключают свой репозиторий GitHub или загружают свою коллекцию API, а Theneo затем все анализирует и предоставляет необходимую документацию. Он также предлагает ИИ-помощника, который использует обработку естественного языка (NLP) для улучшения документации, включая автоматическое описание различных атрибутов API.

«Наш ИИ помощник создает описания для полей, на создание которых разработчику или техническому писателю часто требуется значительное количество времени, особенно когда в ваших API тысячи полей», — пояснил Робакидзе.

В то время как Theneo предназначен для максимальной автоматизации процесса, разработчикам и другим членам команды все таки будет необходимо точно настроить форматы и формулировки, добавить больше изображений или все, что нужно.

«Мы анализируем API, разбираем его, а затем возвращаем уже хорошо структурированный документ», — сказал Робакидзе. «Затем пользователь может выбрать, добавлять ли дополнительные сведения, такие как изображения и различные виджеты, а также добавлять членов команды, чтобы они могли сотрудничать».

Хотя движок, лежащий в основе Theneo, одинаков как для внутреннего, так и для внешнего API, компания предоставляет дополнительные инструменты для последнего, признавая, что сторонние разработчики ценят приятный интерфейс, за которым легче следовать. Таким образом, это, по сути, white-label продукт, который можно адаптировать и брендировать в соответствии с требованиями компании.

С точки зрения ценообразования, у Theneo в настоящее время есть базовый план, который стоит около 20 долларов в месяц на пользователя, и до 45 долларов в месяц для неограниченного количества проектов. Стартап также предлагает корпоративный план, который открывает такие функции, как индивидуальный брендинг и возможность размещения на своих серверах. Он также работает над полностью бесплатной версией, хотя Робакидзе сказал, что она еще не готова к использованию.

Выпускник Y Combinator (YC) уже привлек 1.5 миллиона долларов в качестве пред-посевного финансирования с момента своего основания ровно год назад, и на этой неделе было подтверждено, что он находится в процессе привлечения дополнительного рануда. Кроме того, был представлен обновленный редактор документации, который Робакидзе описал как что-то вроде «Figma for APIs», предназначенный для всех, кто участвует в проекте программного обеспечения, независимо от их технического мастерства.

«Мы поняли, что когда дело доходит до создания API или документации по API, есть несколько игроков, и что для этих пользователей крайне важно сотрудничать», — пояснил Робакидзе. «Подобно тому, что Figma сделала с совместной работой, наш редактор документации API позволяет пользователям сотрудничать, менеджеры и участники, не являющиеся техническими специалистами, могут легко работать вместе над контентом и создавать высококачественные документы».

Робакидзе сказал, что компания в значительной степени открыта для работы с бизнесом любого размера и типа, и в настоящее время она работает примерно с 3,000 компаний, от финтех и государственных учреждений до сельскохозяйственных компаний.

«Нашими крупнейшими клиентами являются финтех-компании, обычно с более чем 20 разработчиками», — сказал Робакидзе.

Если вы нашли опечатку - выделите ее и нажмите Ctrl + Enter! Для связи с нами вы можете использовать info@apptractor.ru.
Advertisement

Популярное

Сообщить об опечатке

Текст, который будет отправлен нашим редакторам: