website logo
InglêsEspanhol
⚫Docs - CITSmart PT
⚫Desenvolvimento CITSmart - PT
🟡Docs - CITSmart 8 - PT
⚫Suporte - CITSmart PT
⚫Workflow - PT
⚫Neuro - PT
⚫Keycloak - PT
⚫CITBot - PT
⚫CITDocs PT
⚫Anuva - PT
⚫CITSmart GRP - Gestão de Contratos
Navigate through spaces
⌘K
Visão Geral
Registrar operação web service
Carregar operações
Configurando acesso no CITSmart Webservices
Toolkit
Alterar SLA via script Rhino
Webservice
Exemplos de utilização de webservices
Webservices no CITSmart
Criação de documentação usando Swagger
Webservices - CITSmart Neuro
Webservices CITSmart Docs
Webservices para uso na plataforma CITSmart
Webservice – Exportação de Dados
APIs
API´s ESP -Enterprise Service Platform
Docs powered by
Archbee
Webservice

Criação de documentação usando Swagger

7min

Procedimento

Para criação da documentação de um webservice com a utilização de Swagger deve-se utilizar dos seguintes critérios:

  • A classe que será documentada deve receber a anotação @Api do pacote io.swagger.annotations.Api, que consiste na identificação da categoria a qual o webservice se refere, como por exemplo: ticket, requisição de mudança etc.
  • Dentro da anotação @Api, na propriedade tags é onde se deve colocar a identificação da categoria do webservice a qual recebe um valor do enum ApiTagsEnum.
Document image

  • O enum ApiTagsEnum é o responsável por guardar as categorias ao qual o webservice pode pertencer. Cada enum é composto pelo valor do enum e uma instãncia da classe Tag (pacote springfox.documentation.service.Tag) que recebe o valor do enum e a descrição do que esse enum representa.
Document image

  • Após a configuração desses cenários, para inserir a documentação do webservice de fato, deve se criar uma interface a qual o webservice relacionado deve implementar.
Document image

  • Na interface é o lugar onde a documentação será escrita de fato. São utilizadas mais frequentemente as seguintes anotações:
Document image

  • As demais anotações são as comumente utilizadas em um webservice criado utilizando o spring, que agora são trazidas para a interface para serem implementadas no webservice desejado.
  • Para verificar se a documentação foi adicionada com sucesso, adicione webmvc/swagger-ui.html# após o citsmart/ na url.
Document image

  • Também é possível acessar diretamente a documentação do webservice desejado. Basta informar na url o path do webservice que deseja ver a documentação.
Document image




Did this page help you?
PREVIOUS
Webservices no CITSmart
NEXT
Webservices - CITSmart Neuro
Docs powered by
Archbee
TABLE OF CONTENTS
Procedimento
Docs powered by
Archbee

  • Treinamentos

    Visite nossa plataforma de treinamentos

  • Idioma

    Português
    English

© Copyright CITSmart - 2021