1+ apiVersion : 1.0.0
2+ swaggerVersion : " 1.2"
3+ basePath : " http://localhost:8002/api"
4+ resourcePath : /user
5+ produces :
6+ - application/json
7+ - application/xml
8+ apis :
9+ - path : /user
10+ operations :
11+ - method : POST
12+ summary : Create user
13+ notes : This can only be done by the logged in user.
14+ type : void
15+ nickname : createUser
16+ parameters :
17+ - name : body
18+ description : Created user object
19+ required : true
20+ allowMultiple : false
21+ type : User
22+ paramType : body
23+ - path : /user/createWithArray
24+ operations :
25+ - method : POST
26+ summary : Creates list of users with given input array
27+ notes : " "
28+ type : void
29+ nickname : createUsersWithArrayInput
30+ parameters :
31+ - name : body
32+ description : List of user object
33+ required : true
34+ allowMultiple : false
35+ type : array
36+ items :
37+ $ref : User
38+ paramType : body
39+ - path : /user/createWithList
40+ operations :
41+ - method : POST
42+ summary : Creates list of users with given list input
43+ notes : " "
44+ type : void
45+ nickname : createUsersWithListInput
46+ parameters :
47+ - name : body
48+ description : List of user object
49+ required : true
50+ allowMultiple : false
51+ type : array
52+ items :
53+ $ref : User
54+ paramType : body
55+ - path : " /user/{username}"
56+ operations :
57+ - method : PUT
58+ summary : Updated user
59+ notes : This can only be done by the logged in user.
60+ type : void
61+ nickname : updateUser
62+ parameters :
63+ - name : username
64+ description : name that need to be deleted
65+ required : true
66+ allowMultiple : false
67+ type : string
68+ paramType : path
69+ - name : body
70+ description : Updated user object
71+ required : true
72+ allowMultiple : false
73+ type : User
74+ paramType : body
75+ responseMessages :
76+ - code : 400
77+ message : Invalid username supplied
78+ - code : 404
79+ message : User not found
80+ - method : DELETE
81+ summary : Delete user
82+ notes : This can only be done by the logged in user.
83+ type : void
84+ nickname : deleteUser
85+ parameters :
86+ - name : username
87+ description : The name that needs to be deleted
88+ required : true
89+ allowMultiple : false
90+ type : string
91+ paramType : path
92+ responseMessages :
93+ - code : 400
94+ message : Invalid username supplied
95+ - code : 404
96+ message : User not found
97+ - method : GET
98+ summary : Get user by user name
99+ notes : " "
100+ type : User
101+ nickname : getUserByName
102+ produces :
103+ - application/json
104+ - application/xml
105+ parameters :
106+ - name : username
107+ description : The name that needs to be fetched. Use user1 for testing.
108+ required : true
109+ allowMultiple : false
110+ type : string
111+ paramType : path
112+ responseMessages :
113+ - code : 400
114+ message : Invalid username supplied
115+ - code : 404
116+ message : User not found
117+ - path : /user/login
118+ operations :
119+ - method : GET
120+ summary : Logs user into the system
121+ notes : " "
122+ type : string
123+ nickname : loginUser
124+ produces :
125+ - text/plain
126+ parameters :
127+ - name : username
128+ description : The user name for login
129+ required : true
130+ allowMultiple : false
131+ type : string
132+ paramType : query
133+ - name : password
134+ description : The password for login in clear text
135+ required : true
136+ allowMultiple : false
137+ type : string
138+ paramType : query
139+ responseMessages :
140+ - code : 400
141+ message : Invalid username and password combination
142+ - path : /user/logout
143+ operations :
144+ - method : GET
145+ summary : Logs out current logged in user session
146+ notes : " "
147+ type : void
148+ nickname : logoutUser
149+ produces :
150+ - text/plain
151+ parameters : []
152+ models :
153+ User :
154+ id : User
155+ properties :
156+ id :
157+ type : integer
158+ format : int64
159+ username :
160+ type : string
161+ password :
162+ type : string
163+ email :
164+ type : string
165+ firstName :
166+ type : string
167+ lastName :
168+ type : string
169+ phone :
170+ type : string
171+ userStatus :
172+ type : integer
173+ format : int32
174+ description : User Status
175+ enum :
176+ - 1-registered
177+ - 2-active
178+ - 3-closed
0 commit comments