Middle+
Szükség volt API tervezésére? Használtál OpenAPI-t, Swagger-t?
sobes.tech MI
Válasz az MI-től
Igen, API-k tervezésére volt szükségem. A RESTful API-k leírásához és dokumentálásához az OpenAPI Specification-t (korábban Swagger néven ismert) használtam. Ez lehetővé teszi az API struktúrájának formalizálását, végpontok, módszerek, paraméterek és adatmodellek leírását, valamint automatikusan generál dokumentációt és kliens SDK-kat.
Egyszerű végpontleírás példája OpenAPI-ban (YAML):
paths:
/users:
get:
summary: Felhasználók listájának lekérése
responses:
'200':
description: Sikeres válasz
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/User'
components:
schemas:
User:
type: object
properties:
id:
type: integer
name:
type: string