fastapi-template/openapi.json at main · ukwhatn/fastapi-template · 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
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
162
163
164
165
166
167
168
169
170
171
172
173
{
  "openapi": "3.1.0",
  "info": {
    "title": "FastAPI Template",
    "description": "FastAPIアプリケーションのテンプレート",
    "version": "0.1.0"
  },
  "paths": {
    "/api/v1/": {
      "get": {
        "tags": [
          "root"
        ],
        "summary": "Read Root",
        "description": "ルートエンドポイント",
        "operationId": "read_root_api_v1__get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "additionalProperties": {
                    "type": "string"
                  },
                  "type": "object",
                  "title": "Response Read Root Api V1  Get"
                }
              }
            }
          }
        }
      }
    },
    "/api/system/healthcheck/": {
      "get": {
        "tags": [
          "system"
        ],
        "summary": "Healthcheck",
        "description": "ヘルスチェックエンドポイント\n\n- DB接続状況\n- アプリケーションuptime\n- 環境情報を返す\n\nDB接続に失敗した場合は503 Service Unavailableを返す",
        "operationId": "healthcheck_api_system_healthcheck__get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HealthCheckResponse"
                }
              }
            }
          }
        }
      }
    },
    "/api/system/views/": {
      "get": {
        "tags": [
          "views"
        ],
        "summary": "Index",
        "description": "インデックスページ（テンプレートが有効な場合）",
        "operationId": "index_api_system_views__get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "text/html": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/": {
      "get": {
        "summary": "Root Redirect",
        "description": "ルートパスから/adminへリダイレクト",
        "operationId": "root_redirect__get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {}
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "DatabaseStatus": {
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "healthy",
              "unhealthy"
            ],
            "title": "Status"
          },
          "connection": {
            "type": "boolean",
            "title": "Connection"
          },
          "error": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Error"
          }
        },
        "type": "object",
        "required": [
          "status",
          "connection"
        ],
        "title": "DatabaseStatus",
        "description": "データベース接続状況\n\nAttributes:\n    status: DB接続の状態（healthy/unhealthy）\n    connection: DB接続が確立されているか\n    error: エラーメッセージ（エラー時のみ）"
      },
      "HealthCheckResponse": {
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "ok",
              "unhealthy"
            ],
            "title": "Status"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp"
          },
          "uptime_seconds": {
            "type": "number",
            "title": "Uptime Seconds"
          },
          "database": {
            "$ref": "#/components/schemas/DatabaseStatus"
          },
          "environment": {
            "type": "string",
            "title": "Environment"
          }
        },
        "type": "object",
        "required": [
          "status",
          "timestamp",
          "uptime_seconds",
          "database",
          "environment"
        ],
        "title": "HealthCheckResponse",
        "description": "ヘルスチェックレスポンス\n\nAttributes:\n    status: 全体的なヘルス状態（ok/unhealthy）\n    timestamp: レスポンス生成時刻\n    uptime_seconds: アプリケーション起動からの経過秒数\n    database: データベース接続状況\n    environment: 実行環境（production/staging/local等）"
      }
    }
  }
}