https://github.com/dynapi/dynapi-v1

Dynamic API for (postgresql) Databases
https://github.com/dynapi/dynapi-v1

dynamic-api flask postgresql python3

Last synced: about 2 months ago
JSON representation

Dynamic API for (postgresql) Databases

• Host: GitHub
• URL: https://github.com/dynapi/dynapi-v1
• Owner: DynAPI
• Created: 2023-07-05T07:24:15.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-02T01:13:49.000Z (5 months ago)
• Last Synced: 2024-10-25T14:45:41.077Z (2 months ago)
• Topics: dynamic-api, flask, postgresql, python3
• Language: CSS
• Homepage: https://dynapi-docs.readthedocs.io/en/latest/
• Size: 1.38 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# DynAPI

Dynamic API for (postgresql) Databases

> Please don't install/use this tool yet. It's not developed enough.

## Installation

### Archive (.tgz)

```bash

tar -xf dynapi-{x.x.x}.tgz

cd dynapi

cp api.conf.template api.conf

# edit api.conf

(opt) mv dynapi.service /etc/systemd/system/

./dynapi.run

```

## Documentation

```bash

./scripts/serve-docs

```

# Body

```json5

{

  "columns": ["string"],  // what columns to select in an GET request

  "filter": [

    [

      ["key", "operation", "value"],["key", "operation", "value"] //inner brackets == AND

    ],

    [

      ["[key]", "op", "[value]"] //inner brackets == AND

    ] //outer brackets==OR

  ],

  "object": {

    "[key]": "[value]" //used for PUT and POST columns + values

  },

  "affected": 1,  // checks number of objects affected, if not number or in range of numbers then fail the request

  // "affected": [5, 10],  // this format is also possible

}

```

# Valid Filter operators:

`==`, `=`, `eq`, `!=`, `not`, `>`, `>=`, `<`, `<=`, `glob`, `like`