chore: add examples of using query parameters

Part of #23

Author: php-coder

examples/go/chi/mysql/routes.go

@@ -110,6 +110,31 @@ func registerRoutes(r chi.Router, db *sqlx.DB) {
 		w.WriteHeader(http.StatusNoContent)
 	})
 
+	r.Get("/v1/categories/search", func(w http.ResponseWriter, r *http.Request) {
+		stmt, err := db.PrepareNamed("SELECT id , name , name_ru , slug , hidden FROM categories WHERE hidden = :hidden")
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "PrepareNamed failed: %v\n", err)
+			internalServerError(w)
+			return
+		}
+
+		result := []CategoryDto{}
+		args := map[string]interface{}{
+			"hidden": r.URL.Query().Get("hidden"),
+		}
+		err = stmt.Select(&result, args)
+		switch err {
+		case sql.ErrNoRows:
+			w.WriteHeader(http.StatusNotFound)
+		case nil:
+			w.Header().Set("Content-Type", "application/json")
+			json.NewEncoder(w).Encode(&result)
+		default:
+			fmt.Fprintf(os.Stderr, "Select failed: %v\n", err)
+			internalServerError(w)
+		}
+	})
+
 	r.Get("/v1/categories/{categoryId}", func(w http.ResponseWriter, r *http.Request) {
 		stmt, err := db.PrepareNamed("SELECT id , name , name_ru , slug , hidden FROM categories WHERE id = :categoryId")
 		if err != nil {

examples/js/express/mysql/endpoints.yaml

@@ -77,6 +77,24 @@
         hidden:
           type: boolean
 
+- path: /v1/categories/search
+  get_list:
+    query: >-
+      SELECT id
+           , name
+           , name_ru
+           , slug
+           , hidden
+       FROM categories
+      WHERE hidden = :q.hidden
+    dto:
+      name: CategoryDto
+      fields:
+        id:
+          type: integer
+        hidden:
+          type: boolean
+
 - path: /v1/categories/:categoryId
   get:
     query: >-

examples/js/express/mysql/routes.js

@@ -58,6 +58,19 @@ const register = (app, pool) => {
         )
     })
 
+    app.get('/v1/categories/search', (req, res, next) => {
+        pool.query(
+            'SELECT id , name , name_ru , slug , hidden FROM categories WHERE hidden = :hidden',
+            { "hidden": req.query.hidden },
+            (err, rows, fields) => {
+                if (err) {
+                    return next(err)
+                }
+                res.json(rows)
+            }
+        )
+    })
+
     app.get('/v1/categories/:categoryId', (req, res, next) => {
         pool.query(
             'SELECT id , name , name_ru , slug , hidden FROM categories WHERE id = :categoryId',

examples/python/fastapi/postgres/routes.py

@@ -133,6 +133,28 @@ def post_v1_categories(body: CreateCategoryDto, conn=Depends(db_connection)):
         conn.close()
 
 
+@router.get('/v1/categories/search')
+def get_list_v1_categories_search(hidden, 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
+                         , hidden
+                     FROM categories
+                    WHERE hidden = %(hidden)s
+                    """, {
+                        "hidden": hidden
+                    })
+                return cur.fetchall()
+    finally:
+        conn.close()
+
+
 @router.get('/v1/categories/{categoryId}')
 def get_v1_categories_category_id(categoryId, conn=Depends(db_connection)):
     try:

examples/ts/express/mysql/routes.ts

@@ -61,6 +61,19 @@ const register = (app: Express, pool: Pool) => {
         )
     })
 
+    app.get('/v1/categories/search', (req: Request, res: Response, next: NextFunction) => {
+        pool.query(
+            'SELECT id , name , name_ru , slug , hidden FROM categories WHERE hidden = :hidden',
+            { "hidden": req.query.hidden },
+            (err, rows, fields) => {
+                if (err) {
+                    return next(err)
+                }
+                res.json(rows)
+            }
+        )
+    })
+
     app.get('/v1/categories/:categoryId', (req: Request, res: Response, next: NextFunction) => {
         pool.query(
             'SELECT id , name , name_ru , slug , hidden FROM categories WHERE id = :categoryId',

tests/crud.hurl

@@ -49,6 +49,13 @@ jsonpath "$[0].name_ru" == null
 jsonpath "$[0].slug"    == "sport"
 jsonpath "$[0].hidden"  == true
 
+GET {{ SERVER_URL }} /v1/categories/search?hidden=true
+HTTP 200
+[Asserts]
+jsonpath "$" count     == 1
+jsonpath "$[0].name"   == "Sport"
+jsonpath "$[0].hidden" == true
+
 
 # PUT should update an object
 PUT {{ SERVER_URL }}/v1/categories/1
@@ -71,6 +78,13 @@ jsonpath "$.name_ru"  == "Фауна"
 jsonpath "$.slug"     == "fauna"
 jsonpath "$.hidden"   == false
 
+GET {{ SERVER_URL }} /v1/categories/search?hidden=false
+HTTP 200
+[Asserts]
+jsonpath "$" count     == 1
+jsonpath "$[0].name"   == "Fauna"
+jsonpath "$[0].hidden" == false
+
 
 # DELETE should remove an object
 DELETE {{ SERVER_URL }}/v1/categories/1