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.4.tar.gz (22.0 kB view details)

Uploaded Source

Built Distribution

minimapi-0.0.4-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for minimapi-0.0.4.tar.gz
Algorithm Hash digest
SHA256 2438cc2696d5c7608b42b49dd997e48357d66c7adc1e9b2fba48f576a9a31216
MD5 a4fe13650d240197d15a221792c903e4
BLAKE2b-256 777d6e5bde3578f5a23d404c617e5ca319d582babdfdeba55eb02aa195b93fc4

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for minimapi-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ce2dbe3eb9079a2076a3fb8c80254005240a99ad8f076d944ccf7a2c20f6d525
MD5 2cad99fa4feabb6697938a87f7ef2f64
BLAKE2b-256 de69c4a195c0fdc76d050710a8e85bd17855f46d0ab972f0c911ad728728f855

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