ArangoDB v2.8 reached End of Life (EOL) and is no longer supported.
This documentation is outdated. Please see the most recent version here: Try latest
Develop your own Foxx
This chapter will explain to you how to write a Foxx on your own and use it to enhance the ArangoDB’s functionality. Be it a microservice, an API with a user interface or an internal library.
Before reading this chapter you should make sure to at least read one of the install sections beforehand to get a good staring point. Recommended is the generate section to get started with your own Foxx, but you can also start with an existing one.
Development Mode
At first we will introduce the development mode and describe its side effects. You can skip this section if you do not have access to the file system of ArangoDB as you will not get the benefits of this mode. You will have to stick to the procedure described in New Versions.
Debugging
Next you will learn about the debugging mechanisms if you have set a Foxx into development mode. The app will return more debugging information in this mode like stacktraces. In production mode stacktraces will be kept internally.
Folder structure
If you want to get started with coding this is the section to begin with. It will introduce the folder structure and describes where which files have to be located on server side.
Framework and tools
Now we are entering the reference documentation of tools available in the Foxx framework. The tools contain:
- Controller
- Setup & Teardown
- Repository
- Model
- Queries
- Background Tasks
- Console API
- you may use Javascript Modules and install node modules using npm in the directory containing your
manifest.json.
Finally we want to apply some meta information to the Foxx. How this is done is described in the Meta information chapter.