Skip to content

ls

Назначение

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

Когда использовать

  • Вы хотите увидеть, какие API настроены
  • Вам нужно найти ID спецификации или коллекции
  • Вы хотите проверить, сколько эндпоинтов имеет каждая коллекция
  • Вы хотите отфильтровать спецификации по тегам

Синтаксис

bash
swag2mcp ls [path] [flags]

Аргументы

АргументПозицияОбязательноОписание
path1НетДиректория рабочей области. Если не указан, разрешается по правилам разрешения пути.

Флаги

ФлагСокращениеТипПо умолчаниюОписание
--tags-tstring""Фильтр спецификаций по тегам (через запятую)

Как это работает

Список всех спецификаций

Показывает каждую спецификацию с её доменом, коллекциями и количеством эндпоинтов:

bash
swag2mcp ls

Пример вывода:

Specifications:
  dadjoke (https://icanhazdadjoke.com)
    jokes (3 endpoints)
  meteo (https://meteo.swagger.io/v2)
    forecast (5 endpoints)
    current (8 endpoints)
  binance (https://api.binance.com)
    market-data (12 endpoints)

Фильтр по тегам

Показать только спецификации, имеющие указанные теги:

bash
swag2mcp ls --tags=public
swag2mcp ls --tags=public,internal

Проверка после команды

Используйте ls после add, delete, update или import, чтобы убедиться, что состояние рабочей области соответствует ожиданиям.

Нюансы

  • Автоинициализация: Если файл конфигурации не существует, ls автоматически запускает мастер инициализации.
  • Фильтрация по тегам: Теги разделяются запятыми. Показываются спецификации, соответствующие любому из указанных тегов (логика ИЛИ).
  • Формат вывода: Вывод в виде обычного текста, не JSON. Для машиночитаемого вывода используйте info.