Az API feltérképezési szolgáltatás konfigurálása a REST API-k dokumentálásához.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | A frissítéseket figyelő párhuzamos REST API ügyfelek maximális számát határozza meg. |
apiName | string | Az összesített API neve. | |
publicURL | string | /api | Megadja a nyilvános API dokumentációs végpontok kontextusgyökerét. Az URL-ben nem kell megadni osztásjelet (/). |
swaggerDefinition | string | Fájl helye, vagy egy JSON vagy YAML Swagger kódrészlet URL-címe, vagy az alkalmazás kontextusgyökere, amit összesített Swagger meghatározásként kell kezelni. |
Minden olyan webmodul konfigurálása, amely elérhetővé teszi az API dokumentációt.
Name | Type | Default | Description |
---|---|---|---|
id | karaktersorozat | Egyedi konfigurációazonosító. | |
contextRoot | string | Azon webmodul kontextusgyökere, amelyhez dokumentációt biztosít. | |
enabled | logikai | true | A webmodul dokumentációjának feldolgozását szabályzó logikai érték. |
docURL | string | A webmodul dokumentációjának URL-címe. Az URL cím lehet relatív a kontextusgyökérhez képest, ha jobbra döntött ferde vonallal (/) kezdődik, vagy abszolút, ha http vagy https előtaggal kezdődik. | |
public | logikai | true | Logikai érték, ami szabályozza, hogy a webmodul megjelenik-e a nyilvános API-ban. |