JSON sxemələri hazırlayırsınızmı, API-ləri təsvir etmək üçün OpenAPI, Swagger istifadə edirsinizmi?

Bəli, JSON sxemləri, OpenAPI və Swagger tez-tez API-ləri təsvir etmək üçün istifadə olunur. JSON sxemləri API vasitəsilə ötürülən məlumatların strukturunu formalizə etməyə kömək edir, bu da validasiya və sənədləşdirmənin yaradılmasını asanlaşdırır.

OpenAPI (əvvəlki adıyla Swagger) RESTful API-ləri təsvir etmək üçün spesifikasiyadır və anlaşılan sənədlər yaratmağa, müştəri və server SDK-larını yaratmağa və API-ni sınaqdan keçirməyə imkan verir. Məsələn, OpenAPI ilə bütün endpointlər, metodlar, parametrlər və məlumat modelləri təsvir edilə bilər.

Sadə OpenAPI təsviri nümunəsi:

openapi: 3.0.0
info:
  title: Nümunə API
  version: 1.0.0
paths:
  /users:
    get:
      summary: İstifadəçilərin siyahısını əldə et
      responses:
        '200':
          description: Uğurlu cavab
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string