Към съдържанието

Валидатор на OpenAPI

Проверете документ OpenAPI 3.0, 3.1 или 3.2 или Swagger 2.0 във формат YAML или JSON и получете обобщение на неговите крайни точки и схеми. Валидаторът проверява задължителните полета, шаблоните на пътищата спрямо параметрите на пътя, местоположението на параметрите, кодовете на отговорите, дублираните идентификатори на операциите и всяка локална $ref, като посочва местоположението на всеки проблем.

Нулиране

Често задавани въпроси

Какво проверява валидаторът?

Проверява версията на openapi или swagger, info.title и info.version, дали пътищата започват с наклонена черта, дали всеки {parameter} в път има съответстващ задължителен параметър на пътя и обратното, имената и местоположението на параметрите, кодовете на състоянието и описанията на отговорите, дублираните параметри и дублираните стойности на operationId, както и дали всяка локална $ref сочи към нещо в документа.

Това пълна валидация на спецификацията спрямо JSON Schema ли е?

Не. Проверяват се описаните по-горе структурни правила, които улавят повечето грешки в написани на ръка документи, но не се валидира всяко поле спрямо официалната метасхема и не се проверява съдържанието на схемите ви.

Какво показва обобщението?

Спецификацията и версията на API, заглавието, таблица с всички крайни точки и техния метод, път, operationId, обобщение и кодове на отговорите, както и имената на схемите под components.schemas или definitions в Swagger 2.0.

Следват ли се външните препратки?

Не. Препратките към други файлове или URL адреси не се извличат и не се съобщават. Разрешават се само препратките, започващи с #, в рамките на поставения документ.

Каква е разликата между грешки и предупреждения?

Грешките нарушават правило на спецификацията, например липсващо описание на отговор или недеклариран параметър на пътя. Предупрежденията посочват неща, които са разрешени, но обикновено не са предвидени, например GET операция с тяло на заявка или документ без нито един operationId.

Променя ли OpenAPI 3.1 задължителните изисквания?

Да. В OpenAPI 3.1 и 3.2 за дадена операция вече не е необходим обект responses, а документът може да съдържа webhooks или components вместо paths. Валидаторът прилага тези правила, когато полето openapi започва с 3.1 или 3.2.

За OneClick Pro

OneClick Pro е безплатна колекция от над 150 уеб инструмента за ежедневна работа: преобразуване на изображения и единици, форматиране и валидиране на код, проверка на домейни и SEO, както и работа с текст, дати и числа. Всеки инструмент работи без регистрация или абонамент, а въведеното от вас се използва само за изчисляване на резултата и никога не се съхранява. Използвайте го като бърз набор от инструменти за еднократни задачи или добавете в отметките инструментите, на които разчитате всеки ден.