Commit 55209c6e9ea8fe471f60f32c881ff2df01688710
1 parent
a0ecd94f
Exists in
master
and in
1 other branch
Documenta geração da apiDoc e os monitoramentos
- Orientação sobre a geração da documentação do serviços com apiDoc. - Documenta os serviços de monitoramento.
Showing
1 changed file
with
26 additions
and
2 deletions
Show diff stats
README.md
... | ... | @@ -12,12 +12,13 @@ Alguns serviços adicionais foram desenvolvidos para extrair dados que não são |
12 | 12 | - Servidor [JBoss EAP 7.0.4](https://developers.redhat.com/products/eap/download/) ou [Wildfly 10](http://wildfly.org/downloads/). |
13 | 13 | - Banco relacional, o Broker foi desenvolvido usando Oracle 12g, mas com pouco esforço pode utilizar o MySQL. |
14 | 14 | - Conexão com a internet para que o Maven acesse os repositórios hospedeiros das dependências. |
15 | +- Ferramenta [apiDoc](http://apidocjs.com/) para gerar a documentação da API. | |
15 | 16 | - [Templates-broker](https://softwarepublico.gov.br/gitlab/ans/templates-broker) implantado e configurado. Este requisito é **opcional**, ele é necessário caso haja interesse em utilizar o [Gerenciador de Templates](https://softwarepublico.gov.br/gitlab/ans/templates-web). |
16 | 17 | |
17 | 18 | ## Procedimentos para instalação |
18 | -### Configure as propriedades dos datasources no JBoss, elas são declaradas como System Properties. | |
19 | +### Configurar as propriedades dos datasources no JBoss. | |
19 | 20 | |
20 | -O broker possui dois datasources e ambos estão declarados no arquivo `sei-broker-ds.xml`, eles são identificados como `jdbc/sei-broker` e `jdbc/sei-mysql`. O `jdbc/sei-broker` foi definido para acessar as tabelas que foram projetadas para o broker, o `jdbc/sei-mysql` se conecta ao banco de dados do SEI. | |
21 | +O broker possui dois datasources e ambos estão declarados no arquivo `sei-broker-ds.xml`, eles são identificados como `jdbc/sei-broker` e `jdbc/sei-mysql`. O `jdbc/sei-broker` foi definido para acessar as tabelas que foram projetadas para o broker, o `jdbc/sei-mysql` se conecta ao banco de dados do SEI. O funcionamento dos datasources depende da declaração de algumas **Systrem Properties** no JBoss. | |
21 | 22 | |
22 | 23 | | Chave | Valor | |
23 | 24 | | --------------------------------------------- | --------------------------------------------- | |
... | ... | @@ -93,3 +94,26 @@ Para essa etapa é necessário ter o Maven instalado e configurado. Ao realizar |
93 | 94 | Após o cadastro do Sistema precisaremos atribuir os serviços que serão utilizados pelo Broker, nesta etapa é preciso ter atenção para o valor que será definido no campo **identificação** e aos **servidores**. A identificação do serviço precisa ser enviada a cada requisição feita aos serviços do SEI, por padrão o Broker utiliza o valor `REALIZAR_INTEGRACAO`. No campo servidores informaremos os IPs dos servidores onde o SEI-Broker estará implantado. |
94 | 95 | |
95 | 96 | Os valores utilizados pelo Broker podem ser configurados na classe `Constantes`, **sigla** e **identificação** são respectivamente `SIGLA_SEI_BROKER` e `CHAVE_IDENTIFICACAO`. |
97 | + | |
98 | +### Gerar documentação da API | |
99 | + | |
100 | +Após a implantação é fundamental que a documentação da API seja disponibilizada para os clientes do Broker. A documentação do Broker foi escrita utilizando a ferramenta [apiDoc](http://apidocjs.com/) e os fontes estão no diretório `/src/main/resources/apidoc/`. Será preciso fazer a instalação do apiDoc[^3] e executar o comando abaixo na raiz do projeto. | |
101 | +[^3]: http://apidocjs.com/#install | |
102 | + | |
103 | +```console | |
104 | +apidoc -f ".*\\.apidoc$" -i src/main/resources/apidoc/ -o <CAMINHO_ONDE_DOCUMENTACAO_SERA_GERADA> | |
105 | +``` | |
106 | + | |
107 | +A documentação gerada deve ser disponibilizada em um local onde possa ser facilmente acessada pelos clientes. | |
108 | + | |
109 | +## Monitoramento do SEI-Broker | |
110 | + | |
111 | +O SEI-Broker oferece três serviços de monitoramento, esses serviços verificam as principais conexões do broker. | |
112 | + | |
113 | +| Monitoramento | URL | | |
114 | +| ----------------------------- | ----------------------------------------------------- | | |
115 | +| Conexão SEI-Broker X MySQL | http://<HOST>/sei-broker/service/info/conexoes/mysql | | |
116 | +| Conexão SEI-Broker X Oracle | http://<HOST>/sei-broker/service/info/conexoes/oracle | | |
117 | +| Conexão SEI-Broker X SEI | http://<HOST>/sei-broker/service/info/conexoes/sei | | |
118 | + | |
119 | +Os serviços respondem com HTTP status **200** caso as conexões estejam ativas, qualquer outro status é considerado como erro de conexão. | ... | ... |