api-guidelines/test.json at master · nimeia/api-guidelines · GitHub

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
{
    "openapi": "3.0.3",
    "info": {
        "title": "A demo Api",
        "description": "Title",
        "license": {
            "name": "no license info",
            "url": "http://www.itgrep.com"
        },
        "contact": {
            "name": "huang",
            "url": "http://www.itgrep.com",
            "email": "hgq@itgrep.com"
        },
        "version": "1.0.0"
    },
    "servers": [
        {
            "url": "http://www.dev.com",
            "description": "dev"
        },
        {
            "url": "https://www.api.com",
            "description": "pro"
        }
    ],
    "components": {
        "headers": {
            "api": {
                "description": "the api headers",
                "schema": {
                    "type": "string"
                }
            }
        },
        "schemas": {
            "User": {
                "type": "object",
                "description": "用户基础信息",
                "discriminator": {
                    "propertyName": "type"
                },
                "properties": {
                    "id": {
                        "type": "integer"
                    },
                    "name": {
                        "type": "string"
                    }
                },
                "example": {
                    "id": "1001",
                    "name": "huang"
                }
            }
        }
    },
    "paths": {
        "/user": {
            "get": {
                "description": "get the user info user the user id",
                "parameters": [
                    {
                        "description": "headers",
                        "in": "header",
                        "$ref": "#/"
                    },
                    {
                        "description": "id",
                        "name": "id",
                        "in": "query"
                    },
                    {
                        "description": "x-api-d",
                        "name": "x-api-id",
                        "in": "header"
                    }
                ],
                "responses": {
                    "200": {
                        "description": "用户信息",
                        "content": {
                            "application/json": {
                                "encoding": {
                                },
                                "schema": {
                                    "$ref": "#/components/schemas/User"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}