Archived
1
0
Fork 0
Not another query language
This repository has been archived on 2019-05-16. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
  • TypeScript 97.2%
  • JavaScript 2.8%
Find a file
2019-05-16 14:57:25 +03:00
lib 0.3.0 2019-05-16 14:57:25 +03:00
spec Update API and fill the docs 2019-05-16 14:56:40 +03:00
.gitignore Update export schema and docs 2019-05-16 14:07:50 +03:00
naql.png Update picture 2019-05-15 22:17:50 +03:00
README.md Update export schema and docs 2019-05-16 14:07:50 +03:00

Not Another Query Language

While it's a common problem to specify query string format for RESTful API, there are a few existing solutions, such as FIQL, RSQL and RSQL. All of them are compliant with URL syntax, however they're not RESTful mostly.

The idea of NAQL is to provide a recomedations on RESTful API query design, but also being quite flexible to adapt to various API specifications. This package consists of two parts:

  • NAQL specification;
  • Node.js library (could be easily ported), which includes the parser from NAQL query string to JSON format, stringifier from JSON structure to NAQL and the converter to SQL query.