JavaAPIBoilerplate/swagger.yaml at main · IranNeto/JavaAPIBoilerplate · 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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
swagger: '2.0'
info:
  description:
    Java API Boilerplate

    [Github project](https://github.com/IranNeto/JavaAPIBoilerplate)
  version: 1.0.0
  title: Java API Boilerplate
basePath: /api/v1/
schemes:
  - http

paths:
  /user/:
    post:
      tags:
        - user
      summary: Persist a user
      description: Persist a user
      operationId: createUser
      produces:
        - application/json
      parameters:
        - in: body
          name: body
          description: Persist a user
          required: true
          schema:
            $ref: '#/definitions/User'
      responses:
        '200':
          description: SUCCESS - Return the user model with id
          schema:
            $ref: '#/definitions/UserPersisted'
        '400':
          description: BAD REQUEST
    get:
      tags:
        - user
      summary: Get all users
      description: Get all users
      operationId: get all users
      produces:
        - application/json
      responses:
        '200':
          description: SUCCESS - Return all the users
          schema:
            items:
              $ref: '#/definitions/UserPersisted'
        '500':
          description: INTERNAL ERROR - Something went wrong
  /user/{id}:
    put:
      tags:
        - user
      summary: Update the user with id passed on url
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: User id
          required: true
          type: integer

        - in: body
          name: body
          description: Update a user
          required: true
          schema:
              $ref: '#/definitions/UserPersisted'
      responses:
        '200':
          description: SUCCESS - Return the user model updated
          schema:
            $ref: '#/definitions/UserPersisted'
        '400':
          description: BAD REQUEST
    get:
      tags:
        - user
      summary: Find a user
      produces:
        - application/json
      parameters:
        - name: id
          in: path
          description: User id
          required: true
          type: integer

      responses:
        '200':
          description: SUCCESS - Return the user model updated
          schema:
            $ref: '#/definitions/UserPersisted'
        '500':
          description: INTERNAL ERROR - Something went wrong
    delete:
      tags:
        - user
      summary: Delete the user with id passed on url
      produces:
        - application/json
      parameters:
        - in: path
          name: id
          description: User id
          required: true
          type: integer
      responses:
        '200':
          description: SUCCESS
        '400':
          description: BAD REQUEST - User does not exists

definitions:
  User:
    type: object
    properties:
      firstname:
        type: string
        example: First name
      lastname:
        type: string
        example: Last name
      state:
        type: string
        example: PE
  UserPersisted:
    type: object
    properties:
      id:
        type: integer
        example: 1
      firstname:
        type: string
        example: First name
      lastname:
        type: string
        example: Last name
      state:
        type: string
        example: PE