Test and Debug CRUD APIs with Swagger

Create API and Testing with Swagger

Above code defines a RESTful API for managing employees, complete with Swagger documentation. The API supports creating, reading, updating, and deleting both individual employees and a list of all employees. The Swagger documentation is automatically generated based on the provided comments. basically its above process help us to testing API with swagger or postman.

Python

from flask import Flask, request
from flask_restful import Api, Resource
from flasgger import Swagger
 
app = Flask(__name__)
api = Api(app)
swagger = Swagger(app)
 
# Simple in-memory data storage for employees
employees_data = [
    {'id': 1, 'name': 'Abhilash Gaurav'},
    {'id': 2, 'name': 'Ramish Verma'}
]
 
# GET and POST Request 
class EmployeesResource(Resource):
    def get(self):
        """
        Get a list of all employees
        ---
        responses:
          200:
            description: A list of employees
        """
        return employees_data, 200
 
    def post(self):
        """
        Add a new employee
        ---
        parameters:
          - in: body
            name: body
            required: true
            schema:
              id: Employee
              required:
                - name
              properties:
                name:
                  type: string
                  description: The name of the employee
        responses:
          201:
            description: The added employee
          400:
            description: Bad request
        """
        # Get the last ID and increment to create a new unique ID
        new_id = employees_data[-1]['id'] + 1
        data = request.get_json()
        new_employee = {'id': new_id, 'name': data['name']}
        employees_data.append(new_employee)
        return new_employee, 201
       
 
# PUT and DELETE Request 
class EmployeeResource(Resource):
    def put(self, employee_id):
        """
        Update an existing employee
        ---
        parameters:
          - in: path
            name: employee_id
            type: integer
            required: true
          - in: body
            name: body
            required: true
            schema:
              id: Employee
              properties:
                name:
                  type: string
                  description: The name of the employee
        responses:
          200:
            description: The updated employee
          404:
            description: Employee not found
        """
        data = request.get_json()
        for employee in employees_data:
            if employee['id'] == employee_id:
                # Update the name of the employee
                employee['name'] = data['name']
                return employee, 200
        return {'message': 'Employee not found'}, 404
 
    def delete(self, employee_id):
        """
        Delete an existing employee
        ---
        parameters:
          - in: path
            name: employee_id
            type: integer
            required: true
        responses:
          200:
            description: Employee deleted successfully
          404:
            description: Employee not found
        """
        for i, employee in enumerate(employees_data):
            if employee['id'] == employee_id:
                # Remove the employee from the list
                deleted_employee = employees_data.pop(i)
                return {'message': 'Employee deleted successfully', 'employee': deleted_employee}, 200
        return {'message': 'Employee not found'}, 404
 
api.add_resource(EmployeesResource, '/employees')
api.add_resource(EmployeeResource, '/employee/<int:employee_id>')
 
if __name__ == '__main__':
    app.run(debug=True)

Output:

Video Demonstration:

Conclusion

Testing APIs with Swagger is a crucial aspect of ensuring the reliability and functionality of web services. Swagger provides a powerful framework for API testing, offering a standardized and interactive documentation platform. By defining API requests and expected responses in a Swagger file, developers can easily execute tests and validate endpoints. This process streamlines communication between development and testing teams, fostering collaboration and reducing the likelihood of misinterpretations.

Testing APIs with Swagger

API testing in Swagger involves validating the functionality and performance of APIs developed using the Swagger framework. Swagger, now known as the OpenAPI Specification, provides a standardized way to document and define RESTful APIs. API testing in Swagger focuses on verifying that the API endpoints adhere to the specified OpenAPI documentation, ensuring correct request and response formats, parameter validations, and overall API behavior. This process helps identify and address issues early in the development lifecycle, ensuring that the API functions reliably and efficiently.

Tags:

#Geeks Premier League 2023 #Python Swagger #Python Testing #Geeks Premier League #Python #python