CleanAPI
Pretty tornado wrapper for making lightweight REST API services
Installation:
pip install cleanapi
Example:
Project folders structure:
.
├── handlers
│ └── simple_handler.py
├── log
├── ssl
│ ├── ca.csr
│ └── ca.key
├── static_html
│ └── index.html
└── server_example.py
server_example.py
from cleanapi import server
if __name__ == '__main__':
# uses http protocol
server.start('http', 8080, '/', './handlers', './static_html')
# # uses https protocol
# server.start('https', 8443, '/', './handlers', './static_html',
# path_to_ssl='./ssl', ssl_certfile_name='ca.csr', ssl_keyfile_name='ca.key')
simple_handler.py
from cleanapi.server import BaseHandler
url_tail = '/example.json'
# noinspection PyAbstractClass
class Handler(BaseHandler):
"""
Test API request handler
"""
async def get(self):
self.set_status(200)
self.write({'status': 'working'})
index.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Cleanapy demo</title>
<link rel="icon" href="/favicon.ico" type="image/x-icon" />
</head>
<body>
<h1>Cleanapy demo page</h1>
<p>Everything OK</p>
</body>
</html>
You also may put 'favicon.ico' file to the 'static_html' folder, but it is not necessary.
Then you can test server responses on http://localhost:8080 and http://localhost:8080/example.json
See log/cleanapi.log for information about externel access to the server
Example with PydanticHandler:
pydantic_handler.py
from cleanapi.server import PydanticHandler
from pydantic import BaseModel, validator, NonNegativeInt
from typing import Optional, List
url_tail = '/pydantic.json'
class PydanticRequest(BaseModel):
"""
Pydantic dataclass for request
"""
foo: NonNegativeInt
bar: NonNegativeInt
@validator('foo', 'bar')
def _validate_foo_bar(cls, val: str):
if val == 666:
raise ValueError(f'Values of foo and bar should not be equal to 666')
return val
class PydanticResponse(BaseModel):
"""
Pydantic dataclass for response
"""
summ: Optional[NonNegativeInt]
errors: Optional[List[dict]]
# noinspection PyAbstractClass
class Handler(PydanticHandler):
"""
Example of using PydanticHandler
"""
request_dataclass = PydanticRequest
result_dataclass = PydanticResponse
# noinspection PyUnusedLocal
def process(self, request: request_dataclass) -> result_dataclass:
"""
What the handler should do
:param request: incoming request
:type request: request_dataclass
:return: processing result
:type: result_data class
"""
result = PydanticResponse(summ=request.foo + request.bar, errors=[])
if result.summ > 1000:
raise ValueError('The sum of foo and bar is more than 1000')
return result
def if_exception(self, errors: list) -> None:
"""
What to do if an exception was thrown
:param errors: list of errors
:type errors: list
"""
self.set_status(400)
self.write({'errors': errors})
return
You can not test it with a browser because of POST method using. You have to use a program like Postman or some custom util like my pynger.py
78 Dec 27, 2022
8 Dec 16, 2021
74 Dec 30, 2022
64 Jul 21, 2022
83 Sep 23, 2022
3 Apr 8, 2022
36 Dec 21, 2022
183 Nov 15, 2022
525 Jan 1, 2023
19 Dec 02, 2022
30 Mar 05, 2022
61 Apr 06, 2022
3.7k Dec 30, 2022
491 Dec 08, 2022
4 Nov 16, 2021
4.3k Dec 31, 2022
2 Dec 03, 2021
814 Jan 08, 2023
1 Nov 25, 2021
3.6k Dec 27, 2022
294 Jan 04, 2023
198 Jan 07, 2023
3 Jun 13, 2022
216 Dec 26, 2022
3 Apr 12, 2022
293 Dec 31, 2022
1.6k Jan 09, 2023
29 Nov 20, 2022
5.8k Dec 30, 2022