forked from guoming0000/protoc-gen-go-gin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
161 lines (160 loc) · 6.13 KB
/
openapi.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
153
154
155
156
157
158
159
160
161
# Generated with protoc-gen-openapi
# https://github.com/kollalabs/protoc-gen-openapi
openapi: 3.0.3
info:
title: BlogService API
description: |-
RPC 服务名和方法名，均使用首字母大写驼峰风格，例如service FooService{ rpc GetSomething() }
blog service is a blog demo
version: 0.0.1
paths:
/v1/articles:
post:
tags:
- BlogService
summary: 获取文章列表
description: 可以读取不多于999个文章列表
operationId: BlogService_GetArticles
parameters:
- name: title
in: query
description: 文章标题 @default=默认标题
schema:
type: string
- name: page
in: query
schema:
exclusiveMaximum: true
type: integer
format: int32
- name: pageSize
in: query
description: 字段名使用小写下划线的风格，例如 string status_code = 1
schema:
maximum: !!float 101
type: integer
format: int32
- name: authorId
in: query
description: 作者id
schema:
type: integer
format: int32
- name: email
in: query
schema:
type: string
format: email
- name: name
in: query
schema:
pattern: ^[^[0-9]A-Za-z]+( [^[0-9]A-Za-z]+)*$
type: string
- name: home.lat
in: query
schema:
type: number
format: double
- name: home.lng
in: query
schema:
type: number
format: double
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetArticlesReply'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
/v1/author/{authorId}/articles:
post:
tags:
- BlogService
summary: CreateArticle
description: 新建文章
operationId: BlogService_CreateArticle
parameters:
- name: authorId
in: path
required: true
schema:
type: integer
format: int32
- name: title
in: query
description: 标题名称上注释
schema:
type: string
- name: content
in: query
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Article'
default:
description: Default error response
content:
application/json:
schema:
$ref: '#/components/schemas/Status'
components:
schemas:
Article:
type: object
properties:
title:
type: string
description: 标题名称上注释
content:
type: string
authorId:
type: integer
format: int32
GetArticlesReply:
type: object
properties:
total:
type: integer
format: int64
articles:
type: array
items:
$ref: '#/components/schemas/Article'
GoogleProtobufAny:
type: object
properties:
'@type':
type: string
description: The type of the serialized message.
additionalProperties: true
description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
Status:
type: object
properties:
code:
type: integer
description: The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
format: int32
message:
type: string
description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
details:
type: array
items:
$ref: '#/components/schemas/GoogleProtobufAny'
description: A list of messages that carry the error details. There is a common set of message types for APIs to use.
description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).'
tags:
- name: BlogService