LogoLogo
  • 👋Welcome
  • For the users
    • 📱Download
      • 🔄Update application
    • 📖Offline dictionaries
    • 🌐Dictionaries servers
    • ⁉️Support
  • For the developers
    • 🖥️Getting started
    • 🛠️Develop on Remède
      • 🔌Setup
      • 📁Structure
      • 🧸Development
      • ⚙️API
      • ✨Features
        • ✈️Offline
        • 📒Sheets
        • 🧰DICT Client
      • Android development
    • 📪API
  • Database
    • 🗃️Database
      • 📋Database schema
      • 🗒️Document schema
      • 📦Dataset
      • 🎶Rimes
      • 📍Internationalization
        • 🇬🇧English database
    • 🚧Build Dictionary
      • The building lifecycle
      • Generate my own database
      • About
    • 📌Remède for your project
    • 📎Available formats
      • DICT
      • XDXF
      • CSV
    • ©️Credits
  • Project
    • 📜Story
    • 🙏Contributing
      • 🌐Translation
    • 👣Lifecycles and infrastructure
    • ⏭️Remède Next
Powered by GitBook

Find us

  • Website
  • Github
  • Support

© 2025 The Remède Project and its contributors.

On this page
  • Configuration
  • Developing
  • Start API

Was this helpful?

Edit on GitHub
  1. For the developers
  2. Develop on Remède

API

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

PreviousDevelopmentNextFeatures

Last updated 3 months ago

Was this helpful?

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 .

Developing

Remède API is built using .

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

An open API documentation generated by FastAPI can be found at .

Start API

python3 server.py

Running on !

Documentation available at .

🛠️
⚙️
localhost:8000
localhost:8000/docs
FastAPI
api-remede.camarm.fr
download it