Total Endpoints: {{TOTAL}}
Categories: {{CATEGORIES_COUNT}}
@@ -315,24 +365,22 @@ def setup_docs_routes(app, manager=None, service=None):
# manager and service may be used in future versions for live API testing
_ = manager, service # Suppress lint warnings
- @app.route("/")
- def api_documentation():
+ @app.route("/api/docs")
+ def api_docs_html():
"""
- Display all available API routes with descriptions
+ Display all available API routes with descriptions (HTML version)
+
+ Example: http://localhost:7777/api/docs
"""
try:
# Collect all routes from the Bottle app
routes = []
for route in app.routes:
- # Skip internal routes (like /_*, /static, /config)
+ # Skip internal routes
if route.rule.startswith('/_') or route.rule.startswith('/static'):
continue
- # Skip the docs route itself to avoid self-reference
- if route.rule == '/' and route.method == 'GET':
- continue
-
# Skip OPTIONS and HEAD (usually auto-generated)
if route.method in ('OPTIONS', 'HEAD'):
continue
@@ -490,10 +538,12 @@ def setup_docs_routes(app, manager=None, service=None):
response.content_type = "application/json"
return {"error": "Failed to generate API documentation", "message": str(e)}
- @app.route("/api/docs")
+ @app.route("/api/docs/json")
def api_docs_json():
"""
Get API documentation as JSON (machine-readable format)
+
+ Example: http://localhost:7777/api/docs/json
"""
try:
routes = []
@@ -503,9 +553,6 @@ def setup_docs_routes(app, manager=None, service=None):
if route.rule.startswith('/_') or route.rule.startswith('/static'):
continue
- if route.rule == '/' and route.method == 'GET':
- continue
-
if route.method in ('OPTIONS', 'HEAD'):
continue