-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger.yaml
152 lines (151 loc) · 3.64 KB
/
swagger.yaml
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
146
147
148
149
150
151
152
basePath: /
definitions:
User:
properties:
age:
description: the age for this user
format: int64
type: integer
x-go-name: Age
email:
description: the email for this user
type: string
x-go-name: Email
id:
description: the id for this user
format: uint64
minimum: 1
type: integer
x-go-name: ID
name:
description: the name for this user
type: string
x-go-name: Name
type: object
x-go-package: github.com/shreeharsha-factly/chi-swagger-go/models
host: localhost:1323
info:
description: |-
the purpose of this application is to provide an application
that is using plain go code to define an API
This should demonstrate all the possible comment annotations
that are available to turn go code into a fully compliant swagger 2.0 spec
title: Data Portal API.
version: 0.0.1
paths:
/users:
post:
consumes:
- application/json
description: This will show a user by id.
operationId: addUser
parameters:
- description: single user
in: body
name: User
schema:
properties:
age:
description: the age for this user
format: int64
type: integer
x-go-name: Age
email:
description: the email for this user
type: string
x-go-name: Email
name:
description: the name for this user
type: string
x-go-name: Name
type: object
produces:
- application/json
responses:
"200":
$ref: '#/responses/userResponse'
summary: Get user by id
tags:
- users
/users/{userId}:
delete:
description: This will show a user by id.
operationId: deleteUser
parameters:
- in: path
name: userId
required: true
type: string
x-go-name: UserID
produces:
- application/json
responses:
"200":
$ref: '#/responses/userResponse'
summary: Get user by id
tags:
- users
get:
description: This will show a user by id.
operationId: getUser
parameters:
- in: path
name: userId
required: true
type: string
x-go-name: UserID
produces:
- application/json
responses:
"200":
$ref: '#/responses/userResponse'
summary: Get user by id
tags:
- users
put:
consumes:
- application/json
description: This will show a user by id.
operationId: updateUser
parameters:
- description: single user
in: body
name: User
schema:
properties:
age:
description: the age for this user
format: int64
type: integer
x-go-name: Age
email:
description: the email for this user
type: string
x-go-name: Email
name:
description: the name for this user
type: string
x-go-name: Name
type: object
- in: path
name: userId
required: true
type: string
x-go-name: UserID
produces:
- application/json
responses:
"200":
$ref: '#/responses/userResponse'
summary: Get user by id
tags:
- users
responses:
userResponse:
description: single user returned in response
schema:
$ref: '#/definitions/User'
schemes:
- http
- https
swagger: "2.0"