OpenAPI / Swagger-viser

Gengiv et OpenAPI 3.0 / 3.1- eller Swagger 2.0-dokument (YAML eller JSON) som en gennemsøgelig API-reference — info, servere, mærkede stier, parametre, eksempler på anmodningskroppe genereret ud fra skemaer, svar og sikkerhed. Udvid enhver operation for at bruge Prøv det og sende en live anmodning fra browseren, eller eksportér den som cURL. Dokumenter analyseres lokalt; eksterne $ref-mål og eksterne skemaer hentes ikke (helt lokalt). Ønskes en interaktiv anmodningsopbygger i stedet? Se REST API-klient / -tester og hele API-værktøjer-familien.
OpenAPI- / Swagger-dokument
Prøv det
Parametre
Om denne fremviser: understøtter Swagger 2.0 og OpenAPI 3.0 / 3.1. Referencer løses kun inden for dokumentet (#/components/schemas/…, #/definitions/…); eksterne fil- og URL-referencer rapporteres i stedet for at blive hentet. Kald under Prøv det er underlagt målserverens CORS-politik — blokeres et kald, kan cURL-konverteren eller REST Client bruges til at køre det uden for browserens sandkasse.
OpenAPI vs. Swagger, v2 vs. v3

Swagger var det oprindelige værktøjsnavn; da specifikationsformatet i 2015 blev doneret til Linux Foundation, blev det til OpenAPI, og Swagger lever videre som værktøjsmærke. Et dokument er bygget op af info (metadata), paths (operationer pr. endepunkt) og components (genbrugelige skemaer).

Versionsnøglen fortæller fremviseren, hvilken parser der skal bruges: swagger: "2.0" over for openapi: 3.0.x — v3 flyttede anmodningskroppe ud af parametrene og indførte et rigtigt JSON Schema.