Pular para o conteúdo principal
O AirysChat usa o Swagger 2.0 para documentar a API.

Estrutura de arquivos/diretórios

- swagger/ ### pasta na qual toda a documentação da API está disponível
  - definitions/
  - parameters/
  - paths/
  - index.yml
  - swagger.json

Construir arquivos do Swagger

Uma tarefa rake está disponível para construir o arquivo swagger.json depois de fazer alterações no diretório do swagger.
rake swagger:build

Testando

No modo de desenvolvimento, http://localhost:3000/swagger fica disponível para testar se as alterações da API foram atualizadas.