Валидация
Спецификации API при проектировании проверяются на соответствие набору правил. Правила помогут стандартизировать разработку, минимизировать ошибки и улучшить качество разрабатываемых API.
Например, с помощью правил можно проверить:
- Структуру и формат спецификаций
- Соответствие параметров запросов и ответов заданным требованиям
- Наличие обязательных полей и атрибутов
- Соответствие спецификации API требованиям ИБ
Полный список правил предоставим по запросу.
Чтобы проверить спецификацию, откройте ее в код-редакторе и нажмите кнопку Проверить.
Исправить ошибки автоматически
При редактировании спецификации вы можете исправлять некоторые ошибки автоматически. Для этого:
- Перейдите в окно Ошибки
- Нажмите кнопку Исправить (доступна не для всех ошибок)
- Введите новые параметры
- (необязательно) Отметьте чекбокс Исправить все похожие ошибки
- Подтвердите действие