:gem: [Feature] ChatAPIApp: New /readme route

apis/chat_api.py

@@ -1,9 +1,12 @@
 import argparse
+import markdown2
 import os
 import sys
 import uvicorn
 
+from pathlib import Path
 from fastapi import FastAPI, Depends
+from fastapi.responses import HTMLResponse
 from fastapi.security import HTTPBearer, HTTPAuthorizationCredentials
 from pydantic import BaseModel, Field
 from typing import Union
@@ -123,6 +126,15 @@ class ChatAPIApp:
             data_response = streamer.chat_return_dict(stream_response)
             return data_response
 
+    def get_readme(self):
+        readme_path = Path(__file__).parents[1] / "README.md"
+        with open(readme_path, "r", encoding="utf-8") as rf:
+            readme_str = rf.read()
+        readme_html = markdown2.markdown(
+            readme_str, extras=["table", "fenced-code-blocks", "highlightjs-lang"]
+        )
+        return readme_html
+
     def setup_routes(self):
         for prefix in ["", "/v1", "/api", "/api/v1"]:
             include_in_schema = True if prefix == "" else False
@@ -137,6 +149,12 @@ class ChatAPIApp:
                 summary="Chat completions in conversation session",
                 include_in_schema=include_in_schema,
             )(self.chat_completions)
+        self.app.get(
+            "/readme",
+            summary="README of HF LLM API",
+            response_class=HTMLResponse,
+            include_in_schema=False,
+        )(self.get_readme)
 
 
 class ArgParser(argparse.ArgumentParser):

requirements.txt

@@ -1,6 +1,7 @@
 aiohttp
 fastapi
 httpx
+markdown2[all]
 openai
 pydantic
 requests