liquido/interface-linha-comando/exemplos/pitugues/api-rest/rotas/LEIAME.md

Conjunto de ferramentas para desenvolvimento de aplicações para a internet 100% em português

# Diretório `rotas`

Neste diretório temos uma série de controladores que implementam uma ou mais rotas. Uma rota é um endereço da internet, como por exemplo `http://localhost:3000`, `http://localhost:3000/blog`, `http://localhost:3000/blog/meu-primeiro-artigo`, e assim por diante. Rotas normalmente funcionam com métodos, como GET, POST, PUT e DELETE, e implementadas em Pituguês.

Rotas seguem uma convenção de diretórios. Por exemplo, se queremos implementar uma rota que responda em `http://localhost:3000` (ou seja, a rota raiz), devemos criar neste diretório um arquivo com o nome `inicial.pitu`. Um exemplo de arquivo inicial contém o seguinte:

```js
funcao rota_get(requisicao, resposta):
    resposta.enviar("Olá mundo").status(200)

liquido.rotaGet(rota_get)
```

No entanto, o normal de uma rota REST é servir JSON, XML, ou outros formatos que chamamos de serializáveis. No caso de JSON, usamos o seguinte:

```js
funcao rota_get(requisicao, resposta):
    resposta.json({
        "id": 1,
        "titulo": "Meu primeiro artigo",
        "descricao": "Este é meu primeiro artigo."
    }).status(200)

liquido.rotaGet(rota_get)
```

Se executarmos Liquido em modo servidor e tentarmos acessar `http://localhost:3000` no nosso navegador, se tudo foi feito da maneira certa, teremos uma página com o texto "Olá mundo".

Seguindo os exemplos dados, se quisermos implementar `http://localhost:3000/artigos`, temos duas boas opções:

- Criar dentro de `rotas` um diretório `artigos`, e dentro desse diretório `artigos` um arquivo `inicial.pitu`, com pelo menos uma configuração de rota dentro;
- Criar dentro de `rotas` um arquivo `artigos.pitu`, com pelo menos uma configuração de rota dentro.