შეიქმნით JSON სქემებს, იყენებთ OpenAPI, Swagger- ს API-ების აღწერისთვის?

დიახ, JSON სქემები, OpenAPI და Swagger ხშირად გამოიყენება API-ების აღწერაში. JSON სქემები ეხმარება მონაცემების სტრუქტურის ფორმალიზებაში, რომელიც გადაეცემა API-ის მეშვეობით, რაც ამარტივებს ვალიდაციას და დოკუმენტაციის შექმნას.

OpenAPI (წინა სახელით Swagger) არის სპეციფიკაცია RESTful API-ების აღწერისთვის, რომელიც საშუალებას აძლევს შექმნას გასაგები დოკუმენტები, გენერიროს კლიენტის და სერვერის SDK-ები, ასევე ტესტოს API. მაგალითად, OpenAPI-ს საშუალებით შეიძლება აღწერილ იქნას ყველა ენდპოინტი, მეთოდი, პარამეტრი და მონაცემთა მოდელი.

სადავო მარტივი აღწერის მაგალითი:

openapi: 3.0.0
info:
  title: მაგალითი API
  version: 1.0.0
paths:
  /users:
    get:
      summary: მიიღეთ მომხმარებლების სია
      responses:
        '200':
          description: წარმატებული პასუხი
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string