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
- password
- date
- email
- url
- 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.1.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

minimapi-0.0.1-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for minimapi-0.0.1.tar.gz
Algorithm Hash digest
SHA256 72d0782655f2ca81cc6005374f6685ebe987532b409be32dcaa01bb5333480bc
MD5 a9968e467091465a44644f801843d2c6
BLAKE2b-256 1c879d359e26fd4176760323d0d5b9d046f2be8d25a61b7694f8b1c13b018ced

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for minimapi-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 59b5d94d68d298577f7cea6b6b27d97dd8659dc08f069912bce6a32d5526ee07
MD5 c6f6c17a720126822c189cf6b1e87708
BLAKE2b-256 648e475ff70ba2243ee748975237adabf9eccb84bee5c116febd6626d44c33a5

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