version api

Author: surajit

app.py

@@ -2,9 +2,9 @@
 from fastapi import Request
 from fastapi.templating import Jinja2Templates
 
-from routes import email
-from routes import contact
-from routes import company
+from routes.v1 import email
+from routes.v1 import contact
+from routes.v1 import company
 
 app = FastAPI()
 app.include_router(email.router)

readme.md

@@ -24,6 +24,21 @@ payment. The Organization makes the payment and a payment record is saved in the
    - create .env file and add the keys for env-example
    - alembic upgrade head (to migrate)
    - uvicorn app:app --reload (to run server)
+   - /docs - to view available endpoints
+
+# Endpoints - v1 (Version 1)
+
+    Contact
+        - /api/v1/contacts/ - POST - Create a Contact
+        - /api/v1/contact/<email>/ - GET email by contact
+    
+    Company
+        - /api/v1/companies/ - POST - Create a Company/Organization
+        - /api/v1/company/<company-name>/ - GET - Get company by Name
+    
+    Email
+        - /api/v1/email/send/ - POST - Send an email
+
 
 # External Integrations
 

routes/v1/__init__.py

@@ -10,6 +10,7 @@
 from crud import company as _company
 
 router = APIRouter(
+    prefix='/api/v1',
     tags=["company"],
     responses={404: {"description": "Not found"}},
 )

routes/company.py routes/v1/company.pyroutes/company.py renamed to routes/v1/company.py

@@ -11,6 +11,7 @@
 from crud import company as _company
 
 router = APIRouter(
+    prefix='/api/v1',
     tags=["contact"],
     responses={404: {"description": "Not found"}},
 )

routes/contact.py routes/v1/contact.pyroutes/contact.py renamed to routes/v1/contact.py

@@ -15,13 +15,13 @@
 from dependencies.dependencies import get_db
 
 router = APIRouter(
-    prefix="/email",
+    prefix='/api/v1',
     tags=["email"],
     responses={404: {"description": "Not found"}},
 )
 
 
-@router.post("/send/")
+@router.post("/email/send/")
 async def send_email(request: Request, db: Session = Depends(get_db)):
     try:
         data = await request.json()