History

Peter Rauscher 4260fb1714 Switch from connection string to connection object in API		2023-04-18 15:46:00 -04:00
..
db	Switch from connection string to connection object in API	2023-04-18 15:46:00 -04:00
.gitignore	OAP-40 Align API more closely with ngram generation, fix environment (#21 )	2022-11-14 15:20:43 -05:00
Dockerfile	Setup docker (#26 )	2022-12-13 07:46:08 -05:00
README.md	OAP-68: Combine config.env and database.ini (#52 )	2023-04-07 09:37:43 -04:00
app.js	OAP-68: Combine config.env and database.ini (#52 )	2023-04-07 09:37:43 -04:00
package-lock.json	OAP-68: Combine config.env and database.ini (#52 )	2023-04-07 09:37:43 -04:00
package.json	OAP-68: Combine config.env and database.ini (#52 )	2023-04-07 09:37:43 -04:00
routes.js	Select lists of suggestions or ngrams with /api or /api/ngrams respectively, JSONify ngrams response	2023-04-18 14:50:43 -04:00
validate.js	Select lists of suggestions or ngrams with /api or /api/ngrams respectively, JSONify ngrams response	2023-04-18 14:50:43 -04:00

README.md

OAPEN Suggestion API

Configuration

You can specify the port requests will be served on with the API_PORT variable. The default value is 3001.

Follow the setup instructions to ensure the database environment variables are set.

Endpoints

Endpoint: /GET http://localhost:3001/api/{handle}
- e.g. http://localhost:3001/api/20.400.12657/47581
Endpoint: /GET http://localhost:3001/api/{handle}/?threshold={integer}
- e.g. http://localhost:3001/api/20.400.12657/47581/?threshold=5
Endpoint: /GET http://localhost:3001/api/{handle}/ngrams
- e.g. http://localhost:3001/api/20.400.12657/47581/ngrams