Directual
Menu

Swagger — мощный инструмент для API теперь доступен в Directual

29 сентября 2022 г.

Представляем поддержку Swagger — отличного инструмента OpenAPI, которым вы можете пользоваться в Directual совершенно бесплатно!

Swagger — мощный инструмент для API теперь доступен в Directual

Вы просили об этом — и вот оно! Мы рады сообщить, что теперь в Directual можно выполнять всевозможные замечательные автоматически генерируемые вещи с помощью Swagger.

Почему это важно? Потому что в конечном итоге все, что действительно имеет значение — это сокращение усилий, необходимых для достижения ваших целей, а Swagger сыграет в этом ключевую роль.

Swagger — это инструмент OpenAPI, который помогает генерировать библиотеки на множестве языков, создавать документацию, проводить тестирование (все автоматически) и структурировать данные API. Все это делается через запросы YAML или JSON к вашему API. Он невероятно универсален, да еще и звучит стильно. Что тут может не понравиться?

Давайте немного подробнее разберем, что он умеет.

Создание API

Разработка API от кода (и наоборот)! Генерируйте API на основе самого кода и автоматически дополняйте описания прямо в исходном коде.

Интерактивные API

Вы можете генерировать клиентские библиотеки на более чем 40 языках и в различных форматах, практически полностью избавляясь от написания кода для API-части вашего проекта, а вызовы API можно делать прямо в браузере. И, конечно, вы можете подключить его к множеству других инструментов, чтобы сделать его еще полезнее — например, для автоматизированного тестирования.

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

У Swagger есть собственный HTML-интерфейс, который подключается напрямую к работающим API, чтобы выполнять запросы и отправлять данные. Более того, Swagger умеет считывать структуру API и аннотации, чтобы автоматически генерировать документацию.

Как использовать Swagger вместе с Directual

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

Попробуйте это, включив документацию Swagger в настройках эндпоинта API вашего проекта:

Под настройкой вы найдете ссылку на сам эндпоинт. Скопируйте и вставьте ее в браузер, чтобы протестировать.

Заключение

Swagger, как и Directual, стремится сократить время, затрачиваемое на ручное написание кода, а еще лучше — вообще избавить вас от этого. Используйте оба инструмента вместе, чтобы получить максимум от мощного бэкенда, фронтенда и правильно настроенного API, который свяжет все это воедино.

Если у вас есть вопросы, дайте нам знать, написав на hello@directual.com. Всегда рады вашим сообщениям!

Павел Ершов
Сооснователь и генеральный директор Directual
← Назад к списку