Importimi i OpenAPI / Swagger

Ky është importimi më i plotë i Restorm. Njihen tri versione: Swagger 2.0, OpenAPI 3.0 dhe OpenAPI 3.1.

Importimi

Skedar ▸ Importo (Ctrl+I), pastaj një skedar swagger.json / openapi.json, ose drejtpërdrejt URL-ja e specifikimit.

Nëse URL-ja përgjigjet me 401 ose 403, Restorm ju propozon të bashkëngjitni një vërtetim dhe të riprovoni, pa dalë nga dritarja modale e importimit.

Pema e prodhuar nga një importim OpenAPI në panelin anësor — një dosje për çdo etiketë (pet, store, user) — pranë nënskedës së mirëseardhjes së dosjes së variablave

Çfarë importohet

Elementi i specifikimit	Çfarë bën Restorm me të
`servers` (ose `host` + `basePath` + `schemes`)	URL-ja bazë e mjedisit, me variablat e serverit të zgjidhura
`tags`	Një dosje për çdo etiketë, plus një dosje Other për pjesën tjetër
Çdo veprim	Një kërkesë HTTP, përfshirë metodën dhe shtegun
Parametrat	Parametra shtegu, kërkese dhe koka, të tipizuar (varg, numër, datë-orë, numërim, sekret…)
`requestBody`	Trupi, në tipin e vet të përmbajtjes
`examples`	Trupi i paraplotësuar me shembullin e dhënë
`components` / `definitions`	Dokumentacioni i API-së: modele, përshkrime
`enum`	Numërime të ripërdorshme si tip vlere
Përgjigjet	Të dokumentuara sipas tipit të përmbajtjes

$ref-at zgjidhen, përfshirë përmes komponentëve.

Rreshti components / definitions meriton të theksohet: importimi nuk kufizohet te kërkesat, ai ruan të gjithë dokumentacionin e API-së — përshkrime, modele, skema sigurie, shembuj, numërime. Ai është i shfletueshëm në skedën Docs të dosjes së variablave që del nga importimi, si edhe në atë të çdo kërkese, dhe risinkronizohet nga burimi. Shihni Qasjen dhe përditësimin e dokumentacionit të një API-je të importuar.

Skeda Docs e dosjes së variablave që del nga importimi, me dokumentacionin e API-së dhe përmbajtjen e tij

Siguria

Skemat e sigurisë të deklaruara përkthehen në koka ose parametra të parangjitur, me variablën përkatëse të mjedisit të krijuar për ju:

Skema	Çfarë vendos Restorm
`apiKey` në kokë ose në kërkesë	Një çift i emërtuar sipas skemës, me vlerë `{{<schema>}}`
`http` + `basic`	`Authorization: Basic {{<schema>_credentials}}`
`http` + `bearer`, `oauth2`, `openIdConnect`	`Authorization: Bearer {{<schema>_token}}`

Mbetet vetëm ta plotësoni variablën — ose ta zëvendësoni me një rrugë vërtetimi për të përfituar nga rinovimi automatik.

Përditësimi

OpenAPI dhe Swagger bëjnë pjesë te formatet e risinkronizueshme: butoni Përditëso i dosjes e merr burimin dhe Restorm zbaton deltën — veprimet e reja shtohen, veprimet e zhdukura shënohen si të vjetruara në vend që të fshihen, ndërsa modifikimet tuaja ruhen. Shihni Përditësimin nga burimi.