Generación de la documentación de « Swagger/OpenAPI »

Genera una documentación completa de la API REST que incluya tanto las especificaciones Javadoc de la API como las de Swagger/OpenAPI utilizando los comandos de compilación de Ant en tu entorno de ejecución de Sterling™ Order Management System.

Antes de empezar

Asegúrese de que el entorno de ejecución de su sistema « Sterling Order Management » esté correctamente configurado con los siguientes componentes:

DTK (kit de herramientas de desarrollo) instalado
Entorno de ejecución configurado en el runtime/ directorio
Herramientas de compilación de Ant disponibles

Acerca de esta tarea

Puedes generar la documentación de Swagger/OpenAPI utilizando dos métodos diferentes, según tus necesidades.

Procedimiento

Ve al directorio de ejecución.
```
cd runtime/bin
```
Elige una de las siguientes opciones de generación.
- Opción 1: Generar la documentación completa (enfoque recomendado)
  Generar documentación tanto de la API Javadoc como de Swagger:
```
./sci_ant.sh -f ../properties/xapiDeployer.xml alldocs
```
  Este comando realiza las siguientes tareas:
  - Genera la documentación Javadoc de la API a partir del código fuente.
  - Crea especificaciones JSON de tipo « OpenAPI ».
  - Genera documentación HTML interactiva.
  - Crea un índice de la API en el que se pueden realizar búsquedas.
  Duración : 10-15 minutos (primera vez)
- Opción 2: Generar solo la documentación de Swagger (método más rápido)
  Si ya existe la documentación Javadoc de la API, regenera solo la documentación de Swagger:
```
./sci_ant.sh -f ../properties/xapiDeployer.xml swaggerdoc.generate
```
  Este comando realiza las siguientes tareas:
  - Regenera las especificaciones JSON de OpenAPI.
  - Actualiza la documentación HTML.
  - Reconstruye el índice de búsqueda de la API.
  Duración : 3-5 minutos

Resultados

Una vez generada, la documentación estará disponible en la siguiente ubicación:

runtime/xapidocs/swaggerdoc/
├── JSON/           # OpenAPI 3.0 specifications
├── HTML/           # Interactive HTML documentation
├── index.html      # Main entry point
└── api-index.js    # Search index

Qué hacer a continuación

Acceder a la documentación

Abre la página principal de la documentación en tu navegador utilizando uno de los siguientes métodos:

Sistema de archivos local: file:///path/to/runtime/xapidocs/swaggerdoc/index.html
Servidor web: http://your-server/xapidocs/swaggerdoc/index.html