Building rest API with Bottle Framework

Requirements

• Vs code (or any other Ide according to you)
• BOTTLE framework
• POSTMAN REST client for testing
• And some basic knowledge about python

Installing Bottle Module

• Now first, make sure that you have python installed on your system. Now go to Command prompt and type the command pip install bottle; this command will install the bottle on your system.
• Next step, you have to open your vs code and, under the folder, create the rest.py file.

Importing Bottle

You have to type the code inside the rest.py file

Bottle library consists of the run() method. This method is used to start a server instance. Here, as we can see, run() contains two parameters:

• reloader: whenever we make changes in our code, we have to restart the server, and in that case, the reloader starts auto-reloading the server. By default, its value is False.
• debug: debug is useful in early development. It gives complete information whenever there is an error.

Creating a Dictionary 

Here, we will create a dictionary containing information about employees.

The dictionary name here is the employee. It has two items name and age. It's up to you to take details of an employee as I have taken two here.

Getting Employee Details

First, remember to import get service.

This statement means any get request coming in between will be passed in the function underneath the Decorator.

📌 we have to create a decorator named @get().

📌 Decorator is nothing but a python object which is used for modifying a function or a class.

📌 Moreover, for a considerable list of decorators, check Python Decorator Library

📌 we also pass a null point called employee.

📌 Then we need to call a function getAllEmployee(). And it will simply return the dictionary with key: employees and value: employee.

📌 This will return all the items stored in the dictionary.

 

The complete code is as follows:

Testing the API

Hence when we will run the above code, we will get an URL as shown below:

Now here we are using the POSTMAN REST client for testing API. Below shown is the postman screen.

Now when we will type the URL and click send button, we will get the following result:

Get a Particular Employee's Detail

If we want, we can also get a particular employee's detail instead of all the employees' details. Let's see how.

📌Again, we have taken a decorator and passed a variable name.

📌 And then we have defined a method get_Emp_by_name(name). This method takes the parameter that the variable has passed to the Decorator.

📌 And now we have created a variable that searches the dictionary by name.

📌 and at last, we have returned the selected employee.

 

Now, if we will run the postman application with the new URL along with the employee name, we will get the following result:

Adding the Employee

Now let's try to add the new employee to the list of employees. In order to do that, we must import the request and post method.

📌 Here, we have created a new post decorator

📌 And then we have called a function add_emp(). The task of this function is to tale JSON objects with the information given in the dictionary.

📌 Also, we have created a variable new_emp that will add the employee details.

📌 append() method will add the new employee detail to the existing one.

 

Now in the postman application, select the POST from the dropdown menu. Click on the Body and then select raw and in the text option, select JSON. And then enter the details of the employee :

On clicking the send button, we will get the following result:

Here we can see the name: Brian and age:32 is added.

Deleting the Employee Details

Now the last we are doing is to delete the employee detail. For this, we have to write the code given below:

Import the delete library.

Now we will create a delete decorator. The code is the same as getting employee detail with just a little change. Let's see the code:

📌 In the above code, we have called a method remove_emp() and passed the parameter name i.e., employee name.

📌 Then, we created a variable for searching the selected employee name in the dictionary

📌  and we have used the remove() method to delete the selected object from the employee table.

📌 and at last we have returned the updated list of employees.

 

For running the above code in the postman application, select enter URL along with the employee name to be deleted and select DELETE from the dropdown menu. We will get the result as shown below:

Finally, we can see employee Henry is deleted from the list.

We have successfully built a rest API using the Bottle framework by the above code. For creating this Rest API we have used VS code you can choose IDE according to you. 

Frequently Asked Questions

What is Bottle API?

The bottle is a python micro-framework by which you can just build the rest API in minutes. It is distributed as a single file module and has only Python Standard Library dependency. Bottle helps in creating web development fastly and easily. 

What is Django and the Bottle?

Model-template-view (MTV) is the basis for its design. It includes many tools that application developers require, including an ORM framework, admin panel, directory structure, and more.

Is Apache a WSGI?

A Python application is embedded within the Apache HTTP Server using the mod WSGI module, which enables communication via the Python WSGI interface as specified in Python PEP 333. One Python method for creating high-quality, high-performance web apps is WSGI.

Is REST API a framework?

The REST API is nothing but a part of the framework that handles requests from external consumers.

What does WSGI stand for?

The Web Server Gateway Interface (pronounced whiskey or WIZ-ghee) is a straightforward calling standard used by web servers to route requests to web applications or frameworks created in the Python programming language.

Conclusion

This article discussed the bottle framework and how to build the rest API using Bottle Framework. We started with introducing the bottle framework, and then we saw the requirements to make the rest API and how to install the bottle module, import the bottle, create a dictionary, get employee details, Test the API, and add and delete the employee from the list.

To learn more about  Bottle Web Framework, see Bottle Documentation, Bottle, and Python Frameworks.

Refer to our guided paths on Coding Ninjas Studio to learn more about DSA, Competitive Programming, JavaScript, System Design, etc. Enroll in our courses, refer to the mock test and problems; look at the interview experiences and interview bundle for placement preparations.

Do upvote our blogs if you find them helpful and engaging!

Happy Learning, Ninjas!