https://github.com/php-coder/query2app

Map SQL queries to URLs and generate a whole app
https://github.com/php-coder/query2app

code-generator express fastapi generator golang javascript python rest rest-api scaffold sql typescript

Last synced: 2 months ago
JSON representation

Map SQL queries to URLs and generate a whole app

• Host: GitHub
• URL: https://github.com/php-coder/query2app
• Owner: php-coder
• License: gpl-2.0
• Created: 2020-07-12T14:33:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-07-27T23:21:19.000Z (8 months ago)
• Last Synced: 2025-08-09T13:53:04.420Z (8 months ago)
• Topics: code-generator, express, fastapi, generator, golang, javascript, python, rest, rest-api, scaffold, sql, typescript
• Language: EJS
• Homepage:
• Size: 352 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Query To App

Generates the endpoints (or a whole app) from a mapping (SQL query -> URL)

> [!WARNING]

> This is a proof of concept at this moment. Until it reaches a stable version, it might (and will) break a compatibility.

# How to use

1. Navigate to a project catalog

   ```console

   $ mkdir new-project

   $ cd new-project

   ```

1. Create a mapping file `endpoints.yaml`

   ```console

   $ vim endpoints.yaml

   - path: /v1/categories

     get_list:

       query: >-

         SELECT id, name, name_ru, slug

           FROM categories

          LIMIT :q.limit

     post:

       query: >-

         INSERT INTO categories(name, slug, created_at, created_by, updated_at, updated_by)

         VALUES (:b.name, :b.slug, NOW(), :b.user_id, NOW(), :b.user_id)

   - path: /v1/categories/:categoryId

     get:

       query: >-

         SELECT id, name, name_ru, slug

           FROM categories

          WHERE id = :p.categoryId

     put:

       query: >-

         UPDATE categories

            SET name = :b.name, name_ru = :b.name_ru, slug = :b.slug, updated_at = NOW(), updated_by = :b.user_id

          WHERE id = :p.categoryId

     delete:

       query: >-

         DELETE

           FROM categories

          WHERE id = :p.categoryId

   ```

   Note that the queries use a little unusual named parameters: `:b.name`, `:p.categoryId`, etc The prefixes `q` (query), `b` (body) and `p` (path) are used here in order to bind to parameters from the appropriate sources. The prefixes are needed only during code generation and they will absent from the resulted code.

1. Generate code

   

   Example commands

   | Language   | Command                     | Generated files            | Dependencies |

   | -----------| ----------------------------| ---------------------------| ------------ |

   | JavaScript | `npx query2app --lang js`   | [`app.js`](examples/js/express/mysql/app.js)
[`routes.js`](examples/js/express/mysql/routes.js)
[`package.json`](examples/js/express/mysql/package.json)
[`Dockerfile`](examples/js/express/mysql/Dockerfile) | [`express`](https://www.npmjs.com/package/express)
[`mysql`](https://www.npmjs.com/package/mysql) |

   | TypeScript | `npx query2app --lang ts`   | [`app.ts`](examples/ts/express/mysql/app.ts)
[`routes.ts`](examples/ts/express/mysql/routes.ts)
[`package.json`](examples/ts/express/mysql/package.json)
[`tsconfig.json`](examples/ts/express/mysql/tsconfig.json)
[`Dockerfile`](examples/ts/express/mysql/Dockerfile) | [`express`](https://www.npmjs.com/package/express)
[`mysql`](https://www.npmjs.com/package/mysql) |

   | Golang     | `npx query2app --lang go`   | [`app.go`](examples/go/chi/mysql/app.go)
[`routes.go`](examples/go/chi/mysql/routes.go)
[`go.mod`](examples/go/chi/mysql/go.mod)
[`Dockerfile`](examples/go/chi/mysql/Dockerfile) | [`go-chi/chi`](https://github.com/go-chi/chi)
[`go-sql-driver/mysql`](https://github.com/go-sql-driver/mysql)
[`jmoiron/sqlx`](https://github.com/jmoiron/sqlx) |

   | Python     | `npx query2app --lang python` | [`app.py`](examples/python/fastapi/postgres/app.py)
[`db.py`](examples/python/fastapi/postgres/db.py)
[`routes.py`](examples/python/fastapi/postgres/routes.py)
[`requirements.txt`](examples/python/fastapi/postgres/requirements.txt)
[`Dockerfile`](examples/python/fastapi/postgres/Dockerfile) | [FastAPI](https://github.com/tiangolo/fastapi)
[Uvicorn](https://www.uvicorn.org)
[psycopg2](https://pypi.org/project/psycopg2/) |

   

1. Run the application

   

   Example commands

   | Language   | Commands |

   | -----------| ---------|

   | JavaScript | 
$ npm install
$ export DB_NAME=my-db DB_USER=my-user DB_PASSWORD=my-password
$ npm start
 |

   | TypeScript | 
$ npm install
$ npm run build
$ export DB_NAME=my-db DB_USER=my-user DB_PASSWORD=my-password
$ npm start
 |

   | Golang     | 
$ export DB_NAME=my-db DB_USER=my-user DB_PASSWORD=my-password
$ go run *.go
or
$ go build -o app
$ ./app
 |

   | Python     | 
$ pip install -r requirements.txt
$ export DB_NAME=my-db DB_USER=my-user DB_PASSWORD=my-password
$ uvicorn app:app --port 3000
 |

   

   ---

   :bulb: **NOTE**

   

   While the example used `export` for setting up the environment variables, we don't recommend export variables that way! This was provided as an example to illustrate that an application follows [The Twelve Factors](https://12factor.net/config) and can be configured by passing environment variables. In real life, you will use docker, docker-compose, Kubernetes or other ways to run an app with required environment variables.

   

   ---

   :bulb: **NOTE**

   

   An app also supports other environment variables:

   

   * `PORT`: a port to listen (defaults to `3000`)

   * `DB_HOST` a database host (defaults to `localhost`)

   

   ---

   


1. Test that it works

   

   Examples for curl

   ```console

   $ curl -i http://localhost:3000/v1/categories \

       --json '{"name":"Sport","name_ru":"Спорт","slug":"sport","user_id":100}' 

   HTTP/1.1 204 No Content

   ETag: W/"a-bAsFyilMr4Ra1hIU5PyoyFRunpI"

   Date: Wed, 15 Jul 2020 18:06:33 GMT

   Connection: keep-alive

   $ curl http://localhost:3000/v1/categories

   [{"id":1,"name":"Sport","name_ru":"Спорт","slug":"sport"}]

   $ curl -i -X PUT http://localhost:3000/v1/categories/1 \

       --json '{"name":"Fauna","name_ru":"Фауна","slug":"fauna","user_id":101}'

   HTTP/1.1 204 No Content

   ETag: W/"a-bAsFyilMr4Ra1hIU5PyoyFRunpI"

   Date: Wed, 15 Jul 2020 18:06:34 GMT

   Connection: keep-alive

   $ curl http://localhost:3000/v1/categories/1

   {"id":1,"name":"Fauna","name_ru":"Фауна","slug":"fauna"}

   $ curl -i -X DELETE http://localhost:3000/v1/categories/1

   HTTP/1.1 204 No Content

   ETag: W/"a-bAsFyilMr4Ra1hIU5PyoyFRunpI"

   Date: Wed, 15 Jul 2020 18:06:35 GMT

   Connection: keep-alive

   ```