wallacesfos / CRUD-Projetos

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

#API-DOCS

Para rodar na sua máquina você precisára do docker e docker-compose

Assim que instalado você irá rodar o comando

docker-compose up

assim irá instalar as dependencias e iniciar o projeto.

/projects /

  • GET

    Lista todos os projetos, não necessita de nenhum header de autorização.

    [
      {
        "id": 1,
        "name": "crud-project"
      }
    ]

/projects?actived=[true|false] /

  • GET

    Lista todos os projetos ativos ou não ativos, sendo true os ativos e false os não ativos

    [
      {
        "id": 1,
        "name": "crud-project"
      }
    ]

/projects/:id /

  • GET

    Lista o projeto com id referente passado na URL, não necessita de nenhum header de autorização.

    {
      "id": 1,
      "name": "crud-project"
    }

/projects /

  • POST

    Cria um novo projeto, sendo necessário o nome.

    REQUEST:

      {
        "name": "crud-project"
      }

    RETORNO:

      {
        "name": "crud-project",
        "id": 1
      }

/projects/:id / - PATCH

Atualiza o nome de um projeto

REQUEST:

```json
{
    "name": "juju"
}
```

/projects/:id / - DELETE

Delete um projeto.

RETORNO:

```json
{
  "raw": [],
  "affected": 1
}
```

About


Languages

Language:TypeScript 85.8%Language:JavaScript 9.5%Language:Shell 2.3%Language:Dockerfile 2.3%