Gerando a documentação d Swagger/OpenAPI

Gere uma documentação abrangente da API REST, que inclua tanto o Javadoc da API quanto as especificações do ` Swagger/OpenAPI `, utilizando comandos de compilação do Ant no ambiente de execução do sistema ` Sterling™ Order Management `.

Antes de iniciar

Certifique-se de que o ambiente de execução do seu sistema Sterling Order Management esteja devidamente configurado com os seguintes componentes:

DTK (Kit de Ferramentas de Desenvolvimento) instalado
Ambiente de execução configurado no runtime/ diretório
Ferramentas de compilação do Ant disponíveis

Sobre esta tarefa

Você pode gerar a documentação do Swagger/OpenAPI utilizando duas abordagens diferentes, dependendo das suas necessidades.

Procedimento

Acesse o diretório de execução.
```
cd runtime/bin
```
Escolha uma das seguintes opções de geração.
- Opção 1: Gerar documentação completa (abordagem recomendada)
  Gerar documentação Javadoc e Swagger para a API:
```
./sci_ant.sh -f ../properties/xapiDeployer.xml alldocs
```
  Este comando realiza as seguintes tarefas:
  - Gera a documentação Javadoc da API a partir do código-fonte.
  - Cria especificações JSON para o ` OpenAPI `.
  - Gera documentação HTML interativa.
  - Cria um índice de API pesquisável.
  Duração : 10 a 15 minutos (primeira vez)
- Opção 2: Gerar apenas a documentação do Swagger (abordagem mais rápida)
  Se a documentação Javadoc da API já existir, gere novamente apenas a documentação Swagger:
```
./sci_ant.sh -f ../properties/xapiDeployer.xml swaggerdoc.generate
```
  Este comando realiza as seguintes tarefas:
  - Regenera as especificações JSON do ` OpenAPI `.
  - Atualiza a documentação em HTML.
  - Reconstrói o índice de pesquisa da API.
  Tempo : 3 a 5 minutos

Resultados

Após a geração, a documentação fica disponível no seguinte local:

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

O que fazer depois

Acessando a documentação

Abra a página principal da documentação no seu navegador usando um dos seguintes métodos:

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