Kas teete JSON skeeme, kasutate OpenAPI, Swagger API kirjeldamiseks?

Jah, JSON-mudelid, OpenAPI ja Swagger on sageli kasutatavad API kirjeldamiseks. JSON-mudelid aitavad formaliseerida andmestruktuuri, mis edastatakse API kaudu, mis hõlbustab valideerimist ja dokumentatsiooni loomist.

OpenAPI (varasemalt Swagger) on spetsifikatsioon RESTful API kirjeldamiseks, mis võimaldab luua arusaadavat dokumentatsiooni, genereerida klient- ja server-SDK-sid ning testida API-d. Näiteks saab OpenAPI abil kirjeldada kõiki lõpp-punkte, meetodeid, parameetreid ja andmemudeleid.

Lihtne OpenAPI kirjelduse näide:

openapi: 3.0.0
info:
  title: Näidise API
  version: 1.0.0
paths:
  /users:
    get:
      summary: Saada kasutajate nimekiri
      responses:
        '200':
          description: Edukas vastus
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string