Sobes.tech
Middle

Milliseid telefoni päringu ja vastuse vorminguid toetab OpenAPI?

sobes.tech AI

Vastus AI-lt

OpenAPI ei piirra HTTP-päringute ja vastuste vorminguid, kuid toetab standardina kõiki vorminguid, mida saab kirjeldada MIME-tüüpide (Content-Type ja Accept) kaudu. Kõige sagedamini kasutatavad on:

  • application/json — kõige levinum formaat REST API-de jaoks
  • application/xml — XML-andmetele
  • application/x-www-form-urlencoded — vormandmetele päringutes
  • multipart/form-data — failide üleslaadimiseks

OpenAPI spetsifikatsioonis saab selgelt märkida toetatud vormingud iga lõpp-punkti content sektsioonis, näiteks:

requestBody:
  content:
    application/json:
      schema:
        $ref: '#/components/schemas/Example'
responses:
  '200':
    content:
      application/json:
        schema:
          $ref: '#/components/schemas/ExampleResponse'

Seega toetab OpenAPI paindlikult kõiki vorminguid, kui need on õigesti kirjeldatud MIME-tüüpide ja skeemide kaudu.