მოვალე იყო API-ს დიზაინი? გამოიყენეთ OpenAPI, Swagger?

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

OpenAPI-ში ერთ endpoint-ის მარტივი აღწერის მაგალითი (YAML):

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