Skip to content

Commit a306b63

Browse files
authored
add example
1 parent b4fe052 commit a306b63

1 file changed

Lines changed: 35 additions & 0 deletions

File tree

example/example.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
openapi: 3.0.1
2+
info:
3+
title: Sample API
4+
description: A sample API to demonstrate OpenAPI specification
5+
version: 1.0.0
6+
servers:
7+
- url: https://api.example.com/v1
8+
paths:
9+
/users:
10+
get:
11+
summary: Get all users
12+
responses:
13+
"200":
14+
description: Successful response
15+
content:
16+
application/json:
17+
schema:
18+
type: array
19+
items:
20+
$ref: "#/components/schemas/User"
21+
components:
22+
schemas:
23+
User:
24+
type: object
25+
properties:
26+
id:
27+
type: integer
28+
name:
29+
type: string
30+
email:
31+
type: string
32+
required:
33+
- id
34+
- name
35+
- email

0 commit comments

Comments
 (0)