Konfigurace funkce Zjišťování rozhraní API pro dokumentaci rozhraní API REST.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | Určuje maximální počet souběžných klientů rozhraní REST API čekajících na aktualizace. |
apiName | string | Název agregovaného rozhraní API. | |
publicURL | string | /api | Určuje kontextový kořenový adresář pro koncové body dokumentace k veřejným rozhraním API. Adresa URL nevyžaduje dopředné lomítko (/). |
swaggerDefinition | string | Umístění souboru nebo adresa URL pro úsek kódu Swagger JSON nebo YAML nebo kontextový kořenový adresář aplikace, která se má použít jako agregovaná definice Swagger. |
Konfigurace jednotlivých webových modulů poskytujících dokumentaci rozhraní API, která se má vystavit.
Name | Type | Default | Description |
---|---|---|---|
id | řetězec | Jedinečné ID konfigurace. | |
contextRoot | string | Kontextový kořenový adresář webového modulu, pro který poskytujete dokumentaci. | |
enabled | boolean | true | Logická hodnota, která řídí zpracování dokumentace tohoto webového modulu. |
docURL | string | Adresa URL dokumentace tohoto webového modulu. Adresa URL může být relativní vzhledem ke kontextovému kořenovému adresáři, když začíná dopředným lomítkem (/), nebo absolutní, když začíná na http nebo https. | |
public | boolean | true | Logická hodnota, která řídí, zda se bude webový modul zobrazovat ve veřejném rozhraní API. |