feat: add support for using query parameters

Fix #23

Author: php-coder

README.md

@@ -19,6 +19,7 @@ Generates the endpoints (or a whole app) from a mapping (SQL query -> URL)
        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)
@@ -41,7 +42,7 @@ Generates the endpoints (or a whole app) from a mapping (SQL query -> URL)
            FROM categories
           WHERE id = :p.categoryId
    ```
-   Note that the queries use a little unusual named parameters: `:b.name`, `:p.categoryId`, etc The prefixes `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.
+   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   
    | Language   | Command for code generation | Example of generated files | Libraries |

examples/go/routes.go

@@ -76,8 +76,18 @@ func registerRoutes(r chi.Router, db *sqlx.DB) {
 	})
 
 	r.Get("/v1/categories", func(w http.ResponseWriter, r *http.Request) {
+		nstmt, err := db.PrepareNamed("SELECT id , name , name_ru , slug FROM categories LIMIT :limit")
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "PrepareNamed failed: %v\n", err)
+			w.WriteHeader(http.StatusInternalServerError)
+			return
+		}
+
 		var result []CategoryDto
-		err := db.Select(&result, "SELECT id , name , name_ru , slug FROM categories")
+		args := map[string]interface{}{
+			"limit": r.URL.Query().Get("limit"),
+		}
+		err = nstmt.Get(&result, args)
 		switch err {
 		case sql.ErrNoRows:
 			w.WriteHeader(http.StatusNotFound)

examples/js/endpoints.yaml

@@ -35,7 +35,8 @@
            , name
            , name_ru
            , slug
-        FROM categories
+       FROM categories
+      LIMIT :q.limit
     dto:
       name: CategoryDto
       fields:

examples/js/routes.js

@@ -36,7 +36,8 @@ app.get('/v1/collections/:collectionId/categories/count', (req, res) => {
 
 app.get('/v1/categories', (req, res) => {
     pool.query(
-        'SELECT id , name , name_ru , slug FROM categories',
+        'SELECT id , name , name_ru , slug FROM categories LIMIT :limit',
+        { "limit": req.query.limit },
         (err, rows, fields) => {
             if (err) {
                 throw err

examples/python/routes.py

@@ -60,11 +60,11 @@ def get_v1_collections_collection_id_categories_count(collectionId, conn = Depen
         conn.close()
 
 @router.get('/v1/categories')
-def get_list_v1_categories(conn = Depends(db_connection)):
+def get_list_v1_categories(limit, conn = Depends(db_connection)):
     try:
         with conn:
             with conn.cursor(cursor_factory = psycopg2.extras.RealDictCursor) as cur:
-                cur.execute("SELECT id , name , name_ru , slug FROM categories")
+                cur.execute("SELECT id , name , name_ru , slug FROM categories LIMIT %(limit)s", { "limit": limit })
                 return cur.fetchall()
     finally:
         conn.close()

src/cli.js

@@ -92,8 +92,8 @@ const createApp = async (destDir, lang) => {
 // "SELECT *\n   FROM foo" => "SELECT * FROM foo"
 const flattenQuery = (query) => query.replace(/\n[ ]*/g, ' ');
 
-// "WHERE id = :p.categoryId OR id = :b.id" => "WHERE id = :categoryId OR id = :id"
-const removePlaceholders = (query) => query.replace(/(?<=:)[pb]\./g, '');
+// "WHERE id = :p.categoryId OR id = :b.id LIMIT :q.limit" => "WHERE id = :categoryId OR id = :id LIMIT :limit"
+const removePlaceholders = (query) => query.replace(/(?<=:)[pbq]\./g, '');
 
 // "/categories/:id" => "/categories/{id}"
 // (used only with Golang's go-chi)
@@ -152,6 +152,7 @@ const createEndpoints = async (destDir, lang, config) => {
         'js': {
             'p': 'req.params',
             'b': 'req.body',
+            'q': 'req.query',
         },
         'go': {
             'p': function(param) {
@@ -160,6 +161,9 @@ const createEndpoints = async (destDir, lang, config) => {
             'b': function(param) {
                 return 'dto.' + capitalize(snake2camelCase(param));
             },
+            'q': function(param) {
+                return `r.URL.Query().Get("${param}")`
+            },
         }
     }
 
@@ -171,7 +175,11 @@ const createEndpoints = async (destDir, lang, config) => {
             "endpoints": config,
 
             // "... WHERE id = :p.id" => [ "p.id" ]
-            "extractParamsFromQuery": (query) => query.match(/(?<=:)[pb]\.\w+/g) || [],
+            "extractParamsFromQuery": (query) => query.match(/(?<=:)[pbq]\.\w+/g) || [],
+
+            // "p.id" => "id" + the same for "q" and "b"
+            // (used only with FastAPI)
+            "stipOurPrefixes": (str) => str.replace(/^[pbq]\./, ''),
 
             // "/categories/:categoryId" => [ "categoryId" ]
             // (used only with FastAPI)
@@ -230,6 +238,8 @@ const createEndpoints = async (destDir, lang, config) => {
                         }
                     ).join('\n\t\t\t');
             },
+
+            "placeholdersMap": placeholdersMap,
         }
     );
 

src/templates/routes.go.ejs

@@ -193,7 +193,7 @@ endpoints.forEach(function(endpoint) {
 
 		var result <%- dataType %>
 		args := map[string]interface{}{
-			<%- params.map(p => `"${p.substring(2)}": chi.URLParam(r, "${p.substring(2)}"),`).join('\n\t\t\t') %>
+			<%- /* LATER: extract */ params.map(p => `"${p.substring(2)}": ${placeholdersMap['go'][p.substring(0, 1)](p.substring(2))},`).join('\n\t\t\t') %>
 		}
 		err = nstmt.Get(&result, args)
 <%			} else { -%>

src/templates/routes.py.ejs

@@ -35,14 +35,17 @@ function convertToFastApiPath(path) {
 
 endpoints.forEach(function(endpoint) {
     const path = convertToFastApiPath(endpoint.path)
-    const methodArgs = extractParamsFromPath(endpoint.path)
-    methodArgs.push('conn = Depends(db_connection)')
+    const argsFromPath = extractParamsFromPath(endpoint.path)
 
     endpoint.methods.forEach(function(method) {
         const hasGetOne = method.name === 'get'
         const hasGetMany = method.name === 'get_list'
         const pythonMethodName = generate_method_name(method.name, path)
 
+        // LATER: add support for aggregated_queries (#17)
+        const argsFromQuery = method.query ? extractParamsFromQuery(method.query).map(stipOurPrefixes) : []
+        const methodArgs = Array.from(new Set([...argsFromPath, ...argsFromQuery, 'conn = Depends(db_connection)']))
+
         const queriesWithNames = []
         if (method.query) {
             queriesWithNames.push({ "result" : method.query })