The Firefly III API documentation can be found on api-docs.firefly-iii.org. This repository holds the static website (in the /dist directory) and the source files (in the /src directory).
The source files are split up in paths that correspond to the API endpoints (under /src/v1). General templates and other items are in the templates and shared directory. The API specification is generated by stitching together these files using a build script, the API docs generator.
The results are uploaded to this repository and can be viewed live at api-docs.firefly-iii.org.
Feel free to create a PR on anything. If you want to change endpoints, check out src/v1/paths. Or edit objects in /src/v1/schemas. This is my first API document so feel free to tell me how to improve. Make your changes and submit a pull request.
This repository is branched for each Firefly III version. The main branch holds the latest develop version.
You can see lines in the YAML files that look like this:
_tpl_correlationParameter,3:These are placeholders which will change during build. You see the name of the template (see /src/templates/), and the number tabs to indent the template.
If you want, you can download the yaml file you need from the dist directory and import it into your favorite API development environment to play around with, e.g. Insomnia.
Are you interested in (future) API changes to Firefly III, or other interesting dev-related updates? Sign up to the Firefly III developer newsletter to receive low-frequency updates about the development of Firefly III.
Do you want to contact me? You can email me at james@firefly-iii.org or get in touch through one of the following support channels:
- GitHub Discussions for questions and support
- Gitter.im for a good chat and a quick answer
- GitHub Issues for bugs and issues
- Mastodon for news and updates
If you like Firefly III and if it helps you save lots of money, why not send me a dime for every dollar saved! 🥳
OK that was a joke. If you feel Firefly III made your life better, please consider contributing as a sponsor. Please check out my Patreon and GitHub Sponsors page for more information. You can also buy me a ☕️ coffee at ko-fi.com. Thank you for your consideration.
