Skip to main content

Easy and simple REST API from model

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

minimapi-0.0.6.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

minimapi-0.0.6-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file minimapi-0.0.6.tar.gz.

File metadata

  • Download URL: minimapi-0.0.6.tar.gz
  • Upload date:
  • Size: 22.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for minimapi-0.0.6.tar.gz
Algorithm Hash digest
SHA256 a982f19de3870a981657c56900b87579db1cc0ad6ae41a99e8ed57e1652d16f5
MD5 1272aac14e2cc410e9ebab4d18c37474
BLAKE2b-256 fa0ea9836ed4310ab3ec84426ca42d33c578429e3c3ddae362124bcdc9819304

See more details on using hashes here.

File details

Details for the file minimapi-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: minimapi-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 10.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for minimapi-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6e00a92342562ee63f5ad2440378650b092522cae5d44d663ffb7d638804ed58
MD5 9b18c184db6824c602e26c44a570f6d1
BLAKE2b-256 15c1510951bbc50d2eb1bf56b1ae092d48343733a01e7ad2151b7117ea50c599

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page