Перейти к основному содержимому

Справочник API

Основной уровень (@powerduck/workspace-yaml/core)​

ФункцияОписание
createWorkspaceYaml(options?)Создаёт строку содержимого workspace.yaml
createOpenApiYaml(options)Создаёт строку YAML для OpenAPI 3.2
createWorkspaceWithApi(options)Создаёт содержимое рабочей области и OpenAPI
parseWorkspaceYaml(content)Разбирает и проверяет строку workspace.yaml

createOpenApiYaml(options) — Параметр​

ПараметрТипОбязателенОписание
titlestringДаНазвание API
versionstringНетПо умолчанию "1.0.0"
descriptionstringНетОписание API
contact{ name?, url?, email? }НетКонтактные данные
license{ name, url? }НетИнформация о лицензии
serversArray<{ url, description? }>НетСписок серверов

Файловый уровень (@powerduck/workspace-yaml)​

ФункцияОписание
initializeWorkspace(options)Создаёт файл workspace.yaml на диске
initializeOpenApi(options)Создаёт YAML-файл OpenAPI на диске
createWorkspaceApi(options)Создаёт оба файла атомарно (откат при ошибке)

createWorkspaceApi(options) — Параметр​

ПараметрТипОбязателенОписание
workspaceDirectorystringДаЦелевой каталог
oasIdstringДаУникальный идентификатор API
namestringДаОтображаемое имя
filestringНетОтносительный путь (по умолчанию: oasFiles/${oasId}.openapi.yaml)
titlestringНетНазвание API (по умолчанию: name)
versionstringНетВерсия API (по умолчанию: "1.0.0")
overwriteOpenApibooleanНетПо умолчанию false

Ошибки​

Все ошибки — экземпляры WorkspaceYamlError с машиночитаемым полем code:

КодОписание
INVALID_ARGUMENTНедопустимый входной параметр
ALREADY_EXISTSФайл уже существует, перезапись отключена (false)
NOT_FOUNDФайл не найден
IO_ERRORОшибка операции файловой системы
INVALID_WORKSPACEНекорректная конфигурация рабочей области
INVALID_OPENAPIНекорректный документ OpenAPI
ROLLBACK_FAILEDОшибка отката транзакции