angular-fullstack/generator-angular-fullstack

API query parameters

Open

#358 aberto em 16 de jul. de 2014

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (6.134 stars) (1.268 forks)batch import
Help Wantedenhancementmajor

Description

To control api we are use:

Comparison Query Operators

EQ

  • url: /api/item?name=test
    • name: 'test'
  • url: /api/item?name.second=test
    • "name.second": 'test'

NEQ

  • url: /api/item?name=!test
    • name: $ne: 'test'

GT

  • url: /api/item?name=>1
    • name: $gt: 1

GTE

  • url: /api/item?name=]1
    • name: $gte: 1

LT

  • url: /api/item?name=<1
    • name: $lt: 1

LTE

  • url: /api/item?name=[1
    • name: $lte: 1

IN

  • url: /api/item?name=@1|2|3
    • name: $in: ['1','2','3']

NIN

  • url: /api/item?name=#1|2|3
    • name: $nin: ['1','2','3']

Evaluation Query Operators

REGEX

  • url: /api/item?name=~test
    • name: $regex: 'test'

Sort

  • /api/item?order=name
  • /api/item?order=-name

Limit

  • /api/item?limit=25&skip=0

We make simple module to convert resp.query to "mongose model find"

https://github.com/alexsuslov/wcQuery

Simple use in server api controller:

"use strict"

_ = require("lodash")
Item = require("./item.model")
Query = require("wc-query")
fields = {}

# Get list of items
exports.index = (req, res) ->
  query = Query(req.query)
  Item.find query.conditions, fields, query.options, (err, items) ->
    throw err if err
    return handleError(res, err)  if err
    res.json 200, items

BRGD Alex

Guia do colaborador

Pilha de tecnologia
javascriptnodejsexpressmongodb
Domain
backendapi
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
mostly clear
Prerequisites
Node.js basicsExpress basicsMongoDB query operators
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40
Direção de pesquisa
The issue proposes adding query parameter operators to the generated API. Research the current status of the wcQuery module and whether it's still maintained. Check if the generator's generated code structure still supports such a feature. Review any existing comments or linked issues. If the feature is still desired, implement a module to parse query parameters similar to the example, update the Express controller template, and add documentation.