Metadata-Version: 2.1
Name: fastapi-router-controller
Version: 0.1.1
Summary: A FastAPI utility to allow Controller Class usage
Home-page: https://github.com/KiraPC/fastapi-router-controller
Author: Pasquale Carmine Carbone
Author-email: pasqualecarmine.carbone@gmail.com
License: UNKNOWN
Description: # What this repository contains
        #### A FastAPI utility to allow Controller Class usage
        
        ## Installation: 
        
        install the package
        ```
        pip install fastapi-router-controller
        ```
        
        ## How to use
        
        In a Class module
        
        ```python
        from fastapi import APIRouter
        from fastapi_router_controller import Controller
        
        router = APIRouter()
        controller = Controller(router)
        
        @controller.resource()
        class ExampleController():
            @controller.route.get(
                '/some_aoi', 
                summary='A sample description')
            def sample_api(_):
                return 'A sample response'
        ```
        
        Load the controller to the main FastAPI app
        ```python
        from fastapi import FastAPI
        from fastapi_router_controller import Controller
        
        import ExampleController
        
        app = FastAPI(
            title='A sample application using fastapi_router_controller',
            version="0.1.0")
        
        example_controller = ExampleController()
        app.include_router(example_controller.router())
        ```
        
        ## For some Example use-cases visit the example folder
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
