> ## Documentation Index
> Fetch the complete documentation index at: https://docs.airys.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Documentação da API

O AirysChat usa o [Swagger 2.0](https://swagger.io/specification/v2/) para documentar a API.

### Estrutura de arquivos/diretórios

```bash theme={null}
- 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.

```bash theme={null}
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.