api-docs-generator

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

api-docs-generator

★ 10 Open GitHub ↗

Support repository: A script to generate the API documentation.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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](https://github.com/firefly-iii/api-docs) (in the `src/` directory).

The results are uploaded to the [API documentation](https://github.com/firefly-iii/api-docs) repository (the `dist/` directory) and can be viewed live at [api-docs.firefly-iii.org](https://api-docs.firefly-iii.org/).

## How to build

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

```dotenv
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](https://getcomposer.org/)

`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](https://insomnia.rest/).

![Firefly III API collection in Insomnia](https://raw.githubusercontent.com/firefly-iii/api-docs-generator/main/.github/insomnia-collection.png "Firefly III API collection in Insomnia")

## See the result
You can see the result [on this page](https://api-docs.firefly-iii.org/).

## 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](https://firefly-iii.kit.com/dev) 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 [james@firefly-iii.org](mailto:james@firefly-iii.org) or get in touch through one of the following support channels:

- [GitHub Discussions](https://github.com/firefly-iii/firefly-iii/discussions/) for questions and support
- [Gitter.im](https://gitter.im/firefly-iii/firefly-iii) for a good chat and a quick answer
- [GitHub Issues](https://github.com/firefly-iii/firefly-iii/issues) for bugs and issues
- <a rel="me" href="https://fosstodon.org/@ff3">Mastodon</a> 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](https://www.patreon.com/jc5) and [GitHub Sponsors](https://github.com/sponsors/JC5) page for more information. You can also [buy me a ☕️ coffee at ko-fi.com](https://ko-fi.com/Q5Q5R4SH1). Thank you for your consideration.

api-docs-generator

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README