Configuraţia pentru caracteristica Descoperire API pentru a documenta API-urile REST.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | Specifică numărul maxim de clienţi REST API concurenţi care sunt ascultaţi pentru actualizări. |
apiName | string | Numele API-ului agregat. | |
publicURL | string | /api | Specifică rădăcina de context pentru punctele finale de documentaţie API-uri publice. URL-ul nu are nevoie de bară înclinată înainte (/). |
swaggerDefinition | string | O locaţie de fişier sau un URL a unui fragment JSON sau YAML Swagger sau a unei rădăcini de context a aplicaţiei care urmează să fie luată ca definiţie Swagger agregată. |
Configuraţia pentru fiecare modul web care furnizează documentaţie API de expus.
Name | Type | Default | Description |
---|---|---|---|
id | şir | Un ID de configuraţie unic. | |
contextRoot | string | Rădăcina de context a modulului web pentru care furnizaţi documentaţia. | |
enabled | boolean | true | Un boolean care controlează procesarea documentaţiei pentru acest modul web. |
docURL | string | URL-ul documentaţiei acestui modul web. URL-ul poate fi relativ la rădăcina de context începând cu un slash înainte (/) sau absolut începând cu http sau https. | |
public | boolean | true | Un boolean care controlează dacă este afişat modului web în API-ul public. |