Skip to main content

MinimAPI

MinimAPI is a simple dynamic API backend. Just define your model.json, then your API is ready

See usage examples here

Install

With pip :

pip3 install minimapi

or build with :

python -m build
pip3 install dist/minimapi-*.whl

Model format

Minimalistic data structure definition format for dynamic API backend and interface front

filename: model.json

Example :

{
    "user": {
        "name": {"type": "text"},
        "birthday": {"type": "date"},
        "password": {"type": "password", "tags":["unlistable"]},
        "city": {"type": "foreign", "show": "name"}
    },
    "city": {
        "name": {"type": "text", "tags":["required"]},
        "code": {"type": "number"}
    }
}

Data parameters availables :

- type : data value type [required]
- show : culumn to show client side for foreign key
- tags : array of options

Currently supported types (based on inputs types):

- text
- number
- url
- password
- date
- email
- url
- sha265
- pbkdf2
- totp
- foreign (property name must match another table name, value is foreign data id)

Currently supported tags :

- unlistable : cannot be returned on bulk, replaced by dash in this case
- encrypted : for client side encrypted data, type checking disabled server side
- required : mandatory field

Metadata

Release files for minimapi 0.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for minimapi 0.0.6
File Size Uploaded
minimapi-0.0.6.tar.gz 22.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for minimapi 0.0.6
File Interpreter ABI Platform
minimapi-0.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 32.2 kB

Release files / minimapi-0.0.6.tar.gz

Download URL minimapi-0.0.6.tar.gz
Size 22.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a982f19de3870a981657c56900b87579db1cc0ad6ae41a99e8ed57e1652d16f5
BLAKE2b-256 checksum
How to use checksums
fa0ea9836ed4310ab3ec84426ca42d33c578429e3c3ddae362124bcdc9819304
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.3

Release files / minimapi-0.0.6-py3-none-any.whl

Download URL minimapi-0.0.6-py3-none-any.whl
Size 10.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6e00a92342562ee63f5ad2440378650b092522cae5d44d663ffb7d638804ed58
BLAKE2b-256 checksum
How to use checksums
15c1510951bbc50d2eb1bf56b1ae092d48343733a01e7ad2151b7117ea50c599
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.3

Release history Release notifications | RSS feed

This release

0.0.6 This release

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page