Configuration

No configuration needed for this module.

Usage

To use this module it just needs to be installed. It provides FastAPI-based endpoints by extending fastapi.endpoint.

The module registers an example model API at the following roots:

• POST: /demo/example/

• GET: /demo/example/{id}

• GET: /demo/example/search?code={code}

The authenticated API uses API-KEY

Also, the class APICommonBaseFastAPICase from tests/common_service.py can be inherited in API tests classes from dependent modules in order to reuse the test helpers.

Known issues / Roadmap

There are no known issues for this module.

Bug Tracker

Bugs are tracked on GitLab Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

TODO: Module to be substituted by the OCA module once this ODOO is migrated to the 17th version or further.

Credits

Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.