PYAPI

Description of the project

This is a simple web server built from scratch, to quickly and easily create your APIs. to understad the project : basically I wanted to learn how frameworks like Flask and Expressjs work (how they handle routing, HTTP parsing, connections...etc.), so I created my own Framework, with python and the built-in sockets module. I hope that my server will help you demistify these frameworks since mine is very simple to understand

In this package, you'll find the following components:

• An HTTP server built with sockets from scratch
• An HTTP request parser
• An HTTP body parser
• An HTTP response builder (to easily create valid HTTP responses)
• A routes handler that uses threads

You can take a look at these components to understand how I implemented them, and if you have any feedback, suggestions or questions, please feel free to open a discussion or issue on the repository. If you'd like to make improvements, you're welcome to submit a pull request.

Try the server

Launch the app I made

To launch the demo server, clone the repository, and run the following commands.

cd pyapi
python3 example.py

The server will then be started, you can navigate to http://127.0.0.1:8000/ to see it in action, and read the code to understand how it works.

Or create your own app

To create your own app with this server, you just have to import the server class to your file, and instanciate it, like the following.

from server import Server

# The port parameter is optional, by default it will be 8000
api = Server(port=8000)

Then you can register routes by creating a function decorated by an @api.get('/route') decorator (adapt depending on the HTTP method needed) this function should take two arguments:

1. req : short for request, it's a class that contains all the information about the user's request, (HTTP method, url, headers...). It is made by parsing the HTTP request received from the user with the request_parser class, and putting all the info in the Request class, it is then passed to your function, with all the info about the request.

2. res : short for response, this parameter is from which you wil send a response to the user, you can use the send method to send plain text, html, xml..etc or sendfile method to send a file.

# Creating routes for our application

from server import Server
api = Server(port=8000)

# registering a route for the / url
@api.get("/")
def root_route(req, res):
    res.send("Hello World")

# example of a route with the POST HTTP method
@api.post("/post")
def post_route(req, res):
    submitted_data = req.body["data"]
    print(submitted_data)

Then you cann start your app.

api.start()

Note:  this is just a side-roject, i work on it from time to time, so a LOT of things are not looking good, but i will improve them. thanks for reading!