Sobes.tech
Middle

Milyen tele kérés és válasz formátumokat támogat az OpenAPI?

sobes.tech MI

Válasz az MI-től

Az OpenAPI nem korlátozza a HTTP-kérések és -válaszok formátumait, de alapértelmezés szerint támogatja az összes olyan formátumot, amelyet MIME-típusok (Content-Type és Accept) segítségével lehet leírni. A leggyakrabban használtak:

  • application/json — a legelterjedtebb formátum a REST API-khoz
  • application/xml — XML-adatokhoz
  • application/x-www-form-urlencoded — űrlapadatokhoz a kérésekben
  • multipart/form-data — fájlok feltöltéséhez

Az OpenAPI specifikációban kifejezetten meg lehet adni a támogatott formátumokat a content szakaszban minden végpont esetében, például:

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

Így az OpenAPI rugalmasan támogatja bármilyen formátumot, ha azokat helyesen írják le MIME-típusok és sémák segítségével.