A Data API Builder REST API-dokumentációja a Swaggerrel / OpenAPI-val
Az OpenAPI-specifikáció egy programozási nyelvfüggetlen szabvány a HTTP API-k dokumentálására. A Data API Builder támogatja az OpenAPI szabványt, amely a következőket teszi lehetővé:
- Hozzon létre információkat az összes olyan futásidejű konfigurációban definiált entitásról, amely engedélyezve van a REST-ben.
- Fordítsa le az információkat az OpenAPI-sémának megfelelő formátumba.
- Elérhetővé teszi a létrehozott OpenAPI-sémát egy vizuális felhasználói felületen (Swagger) vagy egy szerializált fájlon keresztül.
OpenAPI description document
A Data API Builder létrehoz egy OpenAPI-leíró dokumentumot a megadott futtatókörnyezet-konfiguráció és az adatbázis-objektum metaadatainak használatával minden definiált REST-kompatibilis entitáshoz. A sémafájl a OpenAPI.NET SDK által biztosított funkciókkal jön létre. A sémafájl jelenleg az OpenAPI Specification v3.0.1-hez igazodva jön létre JSON formátumban.
Az OpenAPI leírási dokumentuma lekérhető a Data API Builderből az elérési útból:
GET /{rest-path}/openapi
Megjegyzés
Alapértelmezés szerint az rest-path
érték konfigurálható api
és konfigurálható. További információ: REST-konfiguráció
SwaggerUI
A Swagger felhasználói felülete egy webalapú felhasználói felületet kínál, amely a létrehozott OpenAPI-specifikáció használatával nyújt információkat a szolgáltatásról.
A Development
Data API Builder módban lehetővé teszi a létrehozott OpenAPI-leírás dokumentum megtekintését egy dedikált végpontról:
GET /swagger
A "Swagger" végpont nincs beágyazva a rest-path
alá, hogy elkerülje a futtatókörnyezetben konfigurált entitásokkal való elnevezési ütközéseket.