Какие обязательные элементы в спецификации OpenAPI - PullRequest
Новая
       30

Какие обязательные элементы в спецификации OpenAPI

1 голос
/ 10 октября 2019

Какие обязательные элементы спецификации OpenAPI? я предполагаю, что OpenAPI, информация и путь, это правильно?

Спасибо

Ответы [ 2 ]

0 голосов
/ 11 ноября 2019

Пожалуйста, перейдите по ссылке ниже, она объясняет минимальные определения, необходимые для спецификации Swagger или OPENAPI, я надеюсь, что используемая вами спецификация OPEN API - это .yaml

https://swagger.io/docs/specification/2-0/basic-structure/

0 голосов
/ 10 октября 2019

Минимальные обязательные поля в определениях OpenAPI:

  • Идентификатор версии OAS, например openapi: 3.0.2 или swagger: 2.0
  • info.title
  • info.version
  • paths - может быть пустым, т. Е. paths: {}

Источник: Спецификация OpenAPI, раздел «Объект OpenAPI»

Пример минимального определения: 

openapi: 3.0.2
info:
  title: My API
  version: 1.0.0
paths: {}

Технически info.title и info.version также могут быть пустыми строками (например, title: ''), хотя на практике это не имеет смысла.

...