OpenAPI/Swagger-generator

Opbygger en OpenAPI 3.0.0-specifikation som pænt formateret JSON fra API-metadata (title, version, description, base URL) og en liste over endepunkter. Hvert endepunkt har en HTTP-metode, sti, summary, parametre (query/path/header/cookie), valgfri request body og et response-map; outputtet udsendes på Preview-tabben med en copy-knap.

1. På Info-tabben skal du udfylde Title, Version, Description og Base URL (bruges som servers[0].url). 2. På Endpoints-tabben skal du klikke på Add for at oprette et nyt endepunktskort. 3. Klik på et kort for at åbne Edit Endpoint-formularen og angiv Path, Method (GET/POST/PUT/DELETE/PATCH), Summary og Description. 4. Åbn Preview-tabben for at læse den live JSON og klik på Copy.

Endepunkter grupperes under paths efter deres sti-streng. Hver operation nøgles af den lillebogstav-metode (get, post, put, delete, patch) under sit path item. Parametre bliver til {name, in, schema:{type}, required, description}-poster. Når en request body er til stede, udsendes den som content nøglet af dens content type med et generisk objekt-schema. responses-objektet udsendes ordret fra dit response-map.