w1cdn/spothole
1
0
Fork 0
mirror of https://git.ianrenton.com/ian/spothole.git synced 2025-10-27 08:49:27 +00:00
Code Issues 11 Packages Projects Releases Wiki Activity

Add apidocs endpoint. Closes #1

Browse Source
This commit is contained in:
Ian Renton
2025-09-28 21:51:13 +01:00
parent b03650eb80
commit e66b061155
2 changed files with 19 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
server/webserver.py
View File

@@ -28,6 +28,7 @@ class WebServer:
bottle.get("/api/spots")(self.serve_api_spots) bottle.get("/api/spots")(self.serve_api_spots)
bottle.get("/api/status")(self.serve_api_status) bottle.get("/api/status")(self.serve_api_status)
bottle.get("/")(self.serve_index) bottle.get("/")(self.serve_index)
bottle.get("/apidocs")(self.serve_apidocs)
bottle.get("/<filepath:path>")(self.serve_static_file) bottle.get("/<filepath:path>")(self.serve_static_file)
# Start the web server # Start the web server
@@ -62,6 +63,13 @@ class WebServer:
self.status = "OK" self.status = "OK"
return bottle.static_file("index.html", root="webassets") return bottle.static_file("index.html", root="webassets")
# Serve the API docs page. This would be accessible as /apidocs/index.html but we need this workaround to make it
# available as /apidocs
def serve_apidocs(self):
self.last_page_access_time = datetime.now(pytz.UTC)
self.status = "OK"
return bottle.static_file("index.html", root="webassets/apidocs")
# Serve general static files from "webassets" directory # Serve general static files from "webassets" directory
def serve_static_file(self, filepath): def serve_static_file(self, filepath):
return bottle.static_file(filepath, root="webassets") return bottle.static_file(filepath, root="webassets")

11
webassets/apidocs/index.html Normal file
View File

@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>API Documentation</title>
</head>
<body>
<redoc spec-url="/apidocs/openapi.yml"></redoc>
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script>
</body>
</html>