OpenApi

Перевод пункта 4.2 OpenAPI Specification. Open API документ, соответствующий спецификации OpenAPI, является объектом JSON и может быть представлен либо в формате JSON, либо в формате YAML. Например, если поле имеет значение массива, то будет использоваться представление массива JSON: { "field": [ 1, 2, 3 ] } Все названия полей в спецификации чувствительны к регистру (case sensitive). Это относится ко всем полям, которые используются в качестве ключей в карте, за исключением тех случаев, когда указано обратное (case insensitive). Схема предоставляет два типа полей: Шаблонные поля ДОЛЖНЫ иметь уникальные имена внутри содержащего их объекта...

Для ведения версионности OpenAPI Specification (OAS) используется Semantic Versioning 2.0.0 (semver) далее по тексту semver specification. Мажорная (major) - основная версия. Первая цифра. Минорная (minor) - дополнительная (младшая) версия. Вторая цифра. Патч (patch) - Версия исправления. Третья цифра. Мажорные и минорные части semver (например, 3.0) ДОЛЖНЫ назначаться набору функций. А патч версии затрагивают ошибки в документе и не относятся к набору функций. Инструмент, который поддерживает OAS 3...

Пакет Laravel Swagger UI позволяет легко сделать файл Swagger вашего проекта доступным в пользовательском интерфейсе Swagger прямо в вашем приложении Laravel. Все, что требуется, это добавить файл OpenAPI в resources/swagger/openapi.json и перейти локально в проекте к /swagger (настраивается)...