Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit 40f88f6

Browse files
Create Knock-Cpp-API-DOC.yaml
add swagger doc
1 parent f5cfaa6 commit 40f88f6

File tree

1 file changed

+139
-0
lines changed

1 file changed

+139
-0
lines changed

‎Doc/Knock-Cpp-API-DOC.yaml‎

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
---
2+
openapi: 3.0.0
3+
info:
4+
title: API Documentation
5+
version: 1.0.0
6+
servers:
7+
- url: https://virtserver.swaggerhub.com/BOHORDOPNG/knockapi/1.0.0
8+
description: SwaggerHub API Auto Mocking
9+
paths:
10+
/addon/compile:
11+
post:
12+
requestBody:
13+
content:
14+
text/plain:
15+
schema:
16+
type: string
17+
example: "#include <iostream> \n int main() { \n std::cout << 123 << std::endl; \n return 0; }"
18+
responses:
19+
"200":
20+
description: Successful response
21+
"400":
22+
description: Bad Request
23+
"500":
24+
description: Internal Server Error
25+
/addon/download:
26+
post:
27+
requestBody:
28+
content:
29+
text/plain:
30+
schema:
31+
type: string
32+
example: "#include <iostream> \n int main() { \n std::cout << 123 << std::endl; \n return 0; }"
33+
responses:
34+
"200":
35+
description: Successful response
36+
"400":
37+
description: Bad Request
38+
"500":
39+
description: Internal Server Error
40+
/addon/assembly:
41+
post:
42+
requestBody:
43+
content:
44+
text/plain:
45+
schema:
46+
type: string
47+
responses:
48+
"200":
49+
description: Successful response
50+
/notes/new:
51+
post:
52+
requestBody:
53+
content:
54+
application/json:
55+
schema:
56+
$ref: '#/components/schemas/notes_new_body'
57+
responses:
58+
"200":
59+
description: Successful response
60+
/notes/recollector:
61+
get:
62+
responses:
63+
"200":
64+
description: Successful response
65+
/notes/items:
66+
post:
67+
responses:
68+
"200":
69+
description: Successful response
70+
/notes/delete:
71+
delete:
72+
parameters:
73+
- name: id
74+
in: query
75+
required: false
76+
style: form
77+
explode: true
78+
schema:
79+
type: array
80+
items:
81+
type: string
82+
responses:
83+
"200":
84+
description: Successful response
85+
/notes/show:
86+
get:
87+
parameters:
88+
- name: id
89+
in: query
90+
required: false
91+
style: form
92+
explode: true
93+
schema:
94+
type: array
95+
items:
96+
type: string
97+
responses:
98+
"200":
99+
description: Successful response
100+
/notes/last:
101+
get:
102+
responses:
103+
"200":
104+
description: Successful response
105+
/crypto/sha256:
106+
get:
107+
parameters:
108+
- name: plain
109+
in: query
110+
required: false
111+
style: form
112+
explode: true
113+
schema:
114+
type: array
115+
items:
116+
type: string
117+
- name: dg
118+
in: query
119+
required: false
120+
style: form
121+
explode: true
122+
schema:
123+
type: array
124+
items:
125+
type: string
126+
responses:
127+
"200":
128+
description: Successful response
129+
components:
130+
schemas:
131+
notes_new_body:
132+
type: object
133+
properties:
134+
nombre:
135+
type: string
136+
conten:
137+
type: string
138+
autor:
139+
type: string

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /