Improve API specs and fix openapi.json link in doc (#7)

docs/components/api/reference.md

@@ -1,3 +1,3 @@
 # ShopEat API reference
 
-<swagger-ui src="/specs/shopeat-api.json"/>
+<swagger-ui src="../../specs/shopeat-api.json"/>

shopeat/api/asgi.py

@@ -3,10 +3,21 @@
 import shopeat.api.accounts.api
 import shopeat.api.groups.api
 import shopeat.api.publish.api
-from shopeat.api.metadata import OPENAPI_TAGS
+from shopeat.api.metadata import (
+    OPENAPI_DESCRIPTION,
+    OPENAPI_TAGS,
+    OPENAPI_TITLE,
+    OPENAPI_VERSION,
+)
 from shopeat.core.database import DATABASE
 
-app = FastAPI(docs_url="/", openapi_tags=OPENAPI_TAGS)
+app = FastAPI(
+    title=OPENAPI_TITLE,
+    description=OPENAPI_DESCRIPTION,
+    version=OPENAPI_VERSION,
+    docs_url="/",
+    openapi_tags=OPENAPI_TAGS,
+)
 
 app.include_router(shopeat.api.accounts.api.router)
 app.include_router(shopeat.api.groups.api.router)

shopeat/api/metadata.py

@@ -1,3 +1,14 @@
+OPENAPI_TITLE = "ShopEat API"
+OPENAPI_DESCRIPTION = """
+Shopeat is an application that helps you plan the recipes you want to cook,
+create shopping lists, and do online shopping with your friends or family.
+
+It allows you to easily plan your meals and save time and money by organizing your shopping in an efficient way. 
+You can use the app to choose recipes based on your preferences and dietary needs, and then generate a shopping list 
+based on the required ingredients. You can also invite your friends or family to join and contribute to the shopping list,
+which can be convenient when organizing shared meals or when you want to share the shopping tasks.
+""".strip()
+OPENAPI_VERSION = "v1"
 OPENAPI_TAGS = [
     {
         "name": "Accounts",