Гайды

Пошаговые инструкции: как конвертировать, проверять, рисовать и вести документацию в Помощнике SA.

WSDLOpenAPI

WSDL в OpenAPI: REST-фасад для SOAP-сервиса

Как получить черновик спецификации OpenAPI из WSDL: операции становятся методами POST, сообщения — схемами запросов и ответов, ошибки — ответом 500.

OpenAPI

Как проверить спецификацию OpenAPI

Что проверяется в редакторе OpenAPI: синтаксис YAML и JSON, повторяющиеся ключи, ссылки $ref, отрисовка в Swagger UI — и как получить ревью дизайна API.

OpenAPIPlantUML

OpenAPI в диаграмму классов PlantUML

Как получить диаграмму классов по схемам спецификации OpenAPI: поля с типами и кратностью, связи между схемами, наследование и перечисления.

OpenAPI

OpenAPI в curl: команды запросов для терминала

Как получить готовые команды curl для каждой операции OpenAPI: адрес и токен в переменных окружения, параметры, заголовки и тела запросов из примеров.

DBMLOpenAPIJSON Schema

Из модели БД в API: DBML в OpenAPI и JSON Schema

Как получить схемы данных для API из модели DBML: таблицы — объекты, типы SQL — типы JSON, перечисления, обязательность и внешние ключи в описаниях.