Configuración de las funciones de la API de descubrimiento para documentar sus API REST.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | Especifica el número máximo de clientes de API REST simultáneos que están a la escucha de actualizaciones. |
apiName | string | El nombre de la API agregada. | |
publicURL | string | /api | Especifica la raíz de contexto para los puntos finales de la documentación de la API. El URL no necesita una barra inclinada (/). |
swaggerDefinition | string | Una ubicación de archivo o un URL de un fragmento de Swagger JSON o YAML, o una raíz de contexto de la aplicación que se ha de tomar como la definición de Swagger agregada. |
Configuración para cada módulo web que proporciona documentación de la API que se va a exponer.
Name | Type | Default | Description |
---|---|---|---|
id | string | Un ID de configuración exclusivo. | |
contextRoot | string | La raíz de contexto del módulo web para el que está proporcionando la documentación. | |
enabled | boolean | true | Un valor booleano que controla el proceso de documentación para este módulo web. |
docURL | string | El URL de la documentación de este módulo web. El URL puede ser relativo a la raíz de contexto si empieza con una barra inclinada (/) o absoluto si empieza por http o https. | |
public | boolean | true | Un valor booleano que controla si se muestra el módulo web en la API pública. |