firefly-iii/api-docs-generator

API docs generator

Introduction

The build-api-docs.php script in this repository generates the API documentation for Firefly III.

The API specification is generated by stitching together a number of YAML files. The yaml files can be found in the API docs repository (in the src/ directory).

The results are uploaded to the API documentation repository (the dist/ directory) and can be viewed live at api-docs.firefly-iii.org.

How to build

Rename .env.example to .env and adjust the variables accordingly, e.g.

API_DESTINATION=../api-docs/dist
API_SOURCE_ROOT=../api-docs/src
API_SERVER=https://demo.firefly-iii.org

Install PHP yaml extension. It should be added to your php.ini automatically.

Install dependencies via Composer

composer install

Generate firefly-iii-develop-v1.yaml files:

php build-and-deploy.php

The resulting firefly-iii-develop-v1.yaml file can be imported into your favorite API development environment to play around with, e.g. Insomnia.

See the result

You can see the result on this page.

Develop with Firefly III

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 need help, or do you want to get in touch?

Do you want to contact me? You can email me at [email protected] 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

Support the development of Firefly III

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.