Պետք էր API նախագծել? Օգտագործել եք OpenAPI, Swagger?

Այո, ինձ անհրաժեշտ էր նախագծել API։ RESTful API-ների նկարագրության և փաստաթղթավորման համար ես օգտագործել OpenAPI Specification-ը (նախկինում հայտնի էր որպես Swagger): Սա թույլ է տալիս API-ի կառուցվածքը ֆորմալացնել, նկարագրել վերջնակետերը, մեթոդները, պարամետրերը և տվյալների մոդելները, ինչպես նաև ավտոմատ կերպով ստեղծել փաստաթղթերը և հաճախորդական SDK-ները:

OpenAPI-ում վերջնակետի պարզ նկարագրության օրինակ (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