Версии и полный контракт API

Версии и полный контракт API

Найти точный контракт API

Начните с карты возможностей, перейдите к руководству по операции, затем проверьте объявляющий тип в SDK, который использует ваш скрипт. Карта показывает, где искать; она не перечисляет все перегрузки.

Выбрать справочник нужной версии

ИсточникЧто он подтверждаетКакую версию сохранить
Сгенерированный справочник APIПубличные объявления и доступные XML-комментарии сборок, из которых он собранВерсию сборки или пакета, использованного при генерации
Сборки SDK и XML-документация экспортированного проекта скриптаКонтракт, доступный компилятору этого проекта, включая унаследованные члены и методы расширенияВерсию EyeAuras, идентификатор сборки и разрешённые версии пакетов
Исходники на фиксированном коммитеРеализацию владения, отмены и регистрации сервисовSHA коммита и ревизии сабмодулей
Дополнительный NuGet SDKПубличный API конкретного пакета, который может отличаться от встроенного APIТочную версию пакета и совместимого хоста

Публичный справочник публикуется отдельно от Wiki. Новая статья или успешное обновление Git не означают, что он был пересобран. Если страница справочника не указывает нужную версию, сверяйте сигнатуру с установленным SDK. Отсутствие сгенерированной страницы не доказывает отсутствие публичного члена в сборке.

Проверить контракт своего скрипта

Экспортируйте скрипт как проект через интеграцию с IDE и откройте его в редакторе. Перейдите к объявлению типа, проверьте базовые типы и методы расширения, прочитайте XML-документацию параметров и результата. Сохраняйте разрешённые зависимости экспортированного проекта: замена пакета на последнюю версию меняет проверяемый контракт.

Например, IVariablesScriptingApi наследует IVariablesAccessor: просмотр только непосредственно объявленных перегрузок Get<T> пропустит унаследованные операции. Сопоставляйте руководство Variables с объявлением интерфейса на фиксированной ревизии и его базовым контрактом. Само объявление не доказывает регистрацию сервиса в каждом хосте; для этого нужна карта контекстов.

В верхнем уровне C# Script EyeAuras можно вывести идентификатор сборки контракта, загруженной текущим хостом:

Log.Info(typeof(EyeAuras.Scripting.Api.IVariablesScriptingApi).Assembly.FullName);

Идентификатор сборки помогает заметить несовпадение, но не определяет однозначно Git-коммит или NuGet-пакет. Сохраняйте также версию EyeAuras и разрешённую версию пакета. Обычному классу-помощнику передайте собственный логгер.

Из чего собирается справочник

Существующая конфигурация DocFX читает выбранные сборки SDK и генерирует страницы контрактов. Фильтр API исключает ряд областей реализации. Поэтому наличие этого справочника не подтверждает покрытие всех дополнительных SDK и сервисов времени выполнения.

Для проверки конкретной версии используйте соответствующие сборки SDK и XML. Ручная копия списка методов не заменяет этот контракт: при изменении реализации в ней расходятся перегрузки, наследование и версия.