As jy steeds nie 'n definisietaal vir masjienleesbare API-spesifikasies gebruik nie, soos OpenAPI (voorheen bekend as Swagger), moet jy dit beslis oorweeg om dit te doen. API's is immers tale vir masjiene om met mekaar te praat.
Is Swagger 'n goeie idee?
Swagger maak 'n baie goeie eerste indruk Boonop dink baie mense dat die moontlikheid om kode uit die dokumentasie te genereer 'n goeie idee is en Swagger voorsien dat ook. Dus die feit dat swaai 'n goeie eerste indruk maak, maak die beperkings en beperkings daarvan minder duidelik.
Wat is die doel van die gebruik van Swagger?
Swagger laat jou toe om die struktuur van jou API's te beskryf sodat masjiene dit kan lees. Die vermoë van API's om hul eie struktuur te beskryf, is die wortel van alle awesomeness in Swagger.
Word Swagger nog gebruik?
Vandag gebruik baie gebruikers steeds die terme " Swagger" om te verwys na die OpenAPI 2.0-spesifikasieformaat, en "Swagger spec" om te verwys na 'n API-beskrywingsdokument in hierdie formaat. RepreZen API Studio gebruik hierdie terme in sommige dele van die UI, maar verwys na OpenAPI 3.0 en later weergawes as "OpenAPI. "
Is swagger net vir REST API?
OpenAPI-spesifikasie (voorheen Swagger-spesifikasie) is 'n API-beskrywingformaat vir REST API's. 'n OpenAPI-lêer laat jou toe om jou hele API te beskryf, insluitend: Beskikbare eindpunte (/gebruikers) en bewerkings op elke eindpunt (GET /gebruikers, POST /gebruikers)