api-doc/api.apib at master · everaldofilho/api-doc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
FORMAT: 1A
HOST: http://localhost:4000

# Modulo Produtos


# Group Usuario

## Usuario [/usuario]
Controle dos usuários

### Create [POST]
+ Request (application/json)

    + Attributes (Usuario)

+ Response 200 (application/json; charset=utf-8)
    + Attributes (UsuarioCreated)

### List [GET]
+ Response 200 (application/json; charset=utf-8)
    + Attributes (array[Usuario])

## Usuario [/usuario/{id}]
+ Parameters
    + id: 1 (number) - Id do Usuário

### View [GET]
+ Response 200 (application/json; charset=utf-8)
    + Attributes (Usuario)

### Edit [PUT]
+ Request (application/json)
    + Attributes (Usuario)

+ Response 200 (application/json; charset=utf-8)
    + Attributes (UsuarioCreated)

### Delete [DELETE]

+ Response 200 (application/json; charset=utf-8)
    + Attributes (DeletadoComSucesso)

# Group Produto

# Data Structures

## Usuario (object)
+ login: username (string)
+ senha: 123 (string)

## UsuarioCreate (Usuario)
+ id: 1 (number)

## UsuarioCreated (object)
+ id: 1 (number)

## DeletadoComSucesso (object)
+ mensage: Deletado com sucesso (string)