diff --git a/robyn/__init__.py b/robyn/__init__.py index f06e58fc8..8403c3075 100644 --- a/robyn/__init__.py +++ b/robyn/__init__.py @@ -1,4 +1,5 @@ import asyncio +import inspect import json import logging import os @@ -106,7 +107,7 @@ def json_handler(): self.add_route(route_type=HttpMethod.GET, endpoint="/openapi.json", handler=json_handler, is_const=False) self.add_route(route_type=HttpMethod.GET, endpoint="/docs", handler=docs_handler, is_const=False) - def add_path_obj(self, route_type, endpoint, openapi_summary, openapi_tags): + def add_openapi_path_obj(self, route_type, endpoint, openapi_summary, openapi_tags): modified_endpoint, path_obj = get_path_obj(endpoint, openapi_summary, openapi_tags) if modified_endpoint not in self.openapi_schema["paths"]: @@ -337,7 +338,6 @@ def get( endpoint: str, const: bool = False, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -347,7 +347,7 @@ def get( """ def inner(handler): - self.add_path_obj("get", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("get", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.GET, endpoint, handler, const, auth_required) @@ -357,7 +357,6 @@ def post( self, endpoint: str, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -367,7 +366,7 @@ def post( """ def inner(handler): - self.add_path_obj("post", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("post", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.POST, endpoint, handler, auth_required=auth_required) @@ -377,7 +376,6 @@ def put( self, endpoint: str, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -387,7 +385,7 @@ def put( """ def inner(handler): - self.add_path_obj("put", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("put", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.PUT, endpoint, handler, auth_required=auth_required) @@ -397,7 +395,6 @@ def delete( self, endpoint: str, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -407,7 +404,7 @@ def delete( """ def inner(handler): - self.add_path_obj("delete", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("delete", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.DELETE, endpoint, handler, auth_required=auth_required) @@ -417,7 +414,6 @@ def patch( self, endpoint: str, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -427,7 +423,7 @@ def patch( """ def inner(handler): - self.add_path_obj("patch", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("patch", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.PATCH, endpoint, handler, auth_required=auth_required) @@ -437,7 +433,6 @@ def head( self, endpoint: str, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -447,7 +442,7 @@ def head( """ def inner(handler): - self.add_path_obj("head", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("head", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.HEAD, endpoint, handler, auth_required=auth_required) @@ -457,7 +452,6 @@ def options( self, endpoint: str, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -467,7 +461,7 @@ def options( """ def inner(handler): - self.add_path_obj("options", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("options", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.OPTIONS, endpoint, handler, auth_required=auth_required) @@ -477,7 +471,6 @@ def connect( self, endpoint: str, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -487,7 +480,7 @@ def connect( """ def inner(handler): - self.add_path_obj("connect", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("connect", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.CONNECT, endpoint, handler, auth_required=auth_required) @@ -497,7 +490,6 @@ def trace( self, endpoint: str, auth_required: bool = False, - openapi_summary: str = "", openapi_tags: list = ["default"], ): """ @@ -507,7 +499,7 @@ def trace( """ def inner(handler): - self.add_path_obj("trace", endpoint, openapi_summary, openapi_tags) + self.add_openapi_path_obj("trace", endpoint, inspect.getdoc(handler), openapi_tags) return self.add_route(HttpMethod.TRACE, endpoint, handler, auth_required=auth_required) diff --git a/testing_application/app.py b/testing_application/app.py index eb8f55f58..b7c34c262 100644 --- a/testing_application/app.py +++ b/testing_application/app.py @@ -17,16 +17,19 @@ @app.get("/") async def welcome(): + """hiiii""" return "hiiiiii" -@app.get("/users/:name/:age", openapi_summary="Get User by ID", openapi_tags=["Users"]) +@app.get("/users/:name/:age", openapi_tags=["Users"]) async def get_user(r: Request): + """Get User by ID""" return {"message": f"User {r.path_params['name']} : {r.path_params['age']}"} -@app.delete("/users/:name/:age", openapi_summary="Delete User by ID", openapi_tags=["Users"]) +@app.delete("/users/:name/:age", openapi_tags=["Users"]) async def delete_user(r: Request): + """Delete User by ID""" return f"Successfully deleted {r.path_params['name']} : {r.path_params['age']}"