A configuração para API Discovery varia para documentar suas APIs REST.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | Especifica o número máximo de clientes da API REST simultâneos recebendo atualizações. |
apiName | string | O nome da API agregada. | |
publicURL | string | /api | Especifica a raiz de contexto para os terminais de documentação da API pública. A URL não requer uma barra (/). |
swaggerDefinition | string | Um local de arquivo, uma URL de um fragmento JSON ou YAML Swagger ou uma raiz de contexto do aplicativo que deve ser tomada como a definição de swagger agregada. |
A configuração para cada módulo da web fornece a documentação API a ser exposta.
Name | Type | Default | Description |
---|---|---|---|
id | sequência | Um ID de configuração exclusivo. | |
contextRoot | string | A raiz de contexto do módulo da web para o qual a documentação está sendo fornecida. | |
enabled | booleano | true | Um booleano que controla o processamento da documentação para esse módulo da web. |
docURL | string | A URL da documentação deste módulo da web. A URL pode ser relativa à raiz de contexto por começar com uma barra (/) ou absoluta começando com http ou https. | |
public | booleano | true | Um booleano que controla se o módulo da web é exibido na API pública. |