Boilerplate API V2

Boilerplate API UPDATE THIS

Health Check

The health-check will show return status 200 with text body:

• DESCRIBE what/how it can be used

URL: /boilerplate/health-check

Method: GET

Example Response:

This is boilerplate API!

Service Description

The service-description will show following information for an API:

• Gives the Python Version the API using

• Gives the list of all installed Python packages

• Gives the name of API

• Gives all the available versions

• Gives a list of middleware being used

• Gives all available routes for each versions.

URL: /user-data/service-description

Method: GET

Example Response:

{
    to be added
}

Employee Resource

class v2.resources.employee.EmployeeResource

Employee Resource Class

# note:: Allowed Methods: GET / POST / PUT / DELETE

GET Method

EmployeeResource.on_get(req: falcon.request.Request, resp: falcon.response.Response, primary_key: Optional[int] = None)

Risk Area GET Method

Request

• Method: GET

• URL 1: https://stag.api.ranenetwork.com/boilerplate/v1/employee

• URL 2: URL/employee-ID

Response Object:

{
    update
}

POST Method

EmployeeResource.on_post(req: falcon.request.Request, resp: falcon.response.Response)

Risk Area POST Method

Request

• Method: POST

• URL: https://stag.api.ranenetwork.com/boilerplate/v1/employee

• Request Object:

  # attributes / values description
  [
      update
      ...
  ]
  
  # Example
  [
      update
  ]
  

Response Object:

{
    update
}

Attention

table_name db action >> description / condition

• employee insert

• history insert

PUT Method

EmployeeResource.on_put(req: falcon.request.Request, resp: falcon.response.Response, primary_key: Optional[int] = None)

Risk Area PUT Method

Request

• Method: PUT

• URL: https://stag.api.ranenetwork.com/boilerplate/v1/employee/1

• Request Object:

  # attributes / values description
  {
      update
  }
  
  # Example
  {
      update
  }
  

Response Object:

{
    update
}

Attention

table_name db action >> description / condition

• employee update

• history insert

DELETE Method

EmployeeResource.on_delete(req: falcon.request.Request, resp: falcon.response.Response, primary_key: Optional[int] = None)

Risk Area Delete Method

Request:

• Method: DELETE

• URL: https://stag.api.ranenetwork.com/boilerplate/v1/employee/1

Response Object::

{
    update
}

Attention

table_name db action >> description / condition

• employee delete

• history insert

Indices and tables

• Index

• Module Index

• Search Page