No project description provided
Project description
Description
JSON-RPC server based on fastapi:
Installation
pip install fastapi-jsonrpc
Usage
pip install uvicorn
import fastapi_jsonrpc as jsonrpc
from fastapi_jsonrpc import Param
app = jsonrpc.API()
api_v1 = jsonrpc.Entrypoint('/api/v1/jsonrpc')
class MyErrorDataModel(BaseModel):
details: str
class MyError(jsonrpc.BaseError):
CODE = 5000
MESSAGE = 'My error'
data_model = MyErrorDataModel
@api_v1.method(errors=[MyError])
def echo(
data: str = Param(..., example='123'),
) -> str:
if data == 'error':
raise MyError(data={'details': 'error'})
return data
app.bind_entrypoint(api_v1)
if __name__ == '__main__':
import uvicorn
uvicorn.run(app, port=5000, debug=True, access_log=False)
Go to:
Development
Install poetry
Install dependencies
poetry update
Install dephell
pip install dephell
Regenerate setup.py
dephell deps convert
Changelog
[0.1.5] Add error usage example to README.rst
[0.1.4] Add description to README.rst
[0.1.3] Fix README.rst
[0.1.2] Add usage example to README.rst
[0.1.1] README.rst
[0.1.0] Initial commit
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
fastapi-jsonrpc-0.1.5.tar.gz
(7.0 kB
view hashes)
Built Distribution
Close
Hashes for fastapi_jsonrpc-0.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 935f5b1b8938f056ad24a4cfc33908f7774485cba154ff9574394592346a3641 |
|
MD5 | 403a28f2ea63633c45a836631c233bb7 |
|
BLAKE2b-256 | 2ed9aaf7d550c26d5447413fcd31992c3e0c765257cb533bb136377173cea699 |