Remède API

The public API of Remède serve the Remède database and more functionalities !

Configuration

• To use the service which permit to users to open issues (about missing words in the dictionary), create a .github.json, file which contains the following:

  {
  "token": "ghp_XXXXXXXX",
  "repo": "camarm-dev/remede",
  "labels": ["word"],
  "assignees": ["camarm-dev"]
  }
  

• To serve the database you need to download it.

Developing

Remède API is built using FastAPI.

You can modify it inside the server.py file at project root.

An open API documentation generated by FastAPI can be found at api-remede.camarm.fr.

Start API

python3 server.py

Running on localhost:8000 !

Documentation available at localhost:8000/docs.