==============

Base Rest Demo

.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png :target: https://odoo-community.org/page/development-status :alt: Beta .. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html :alt: License: LGPL-3 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github :target: https://github.com/OCA/rest-framework/tree/13.0/base_rest_demo :alt: OCA/rest-framework .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png :target: https://translation.odoo-community.org/projects/rest-framework-13-0/rest-framework-13-0-base_rest_demo :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png :target: https://runbot.odoo-community.org/runbot/271/13.0 :alt: Try me on Runbot

|badge1| |badge2| |badge3| |badge4| |badge5|

Demo addon to illustrate how to develop self documented REST services thanks to the base_rest addon.

Table of contents

.. contents:: :local:

Usage

This module provides sample REST services based on baserest. The documentation of provided services is available at the /api-docs URL. This frontend based on Swagger <https://swagger.io/> is generated from the implemented webservices.

Known issues / Roadmap

The roadmap <https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement> and known issues <https://github.com/OCA/rest-framework/issues?q=is%3Aopen+is%3Aissue+label%3Abug> can be found on GitHub.

Changelog

12.0.2.0.0

* Licence changed from AGPL-3 to LGPL-3

12.0.1.0.0

First official version.

Bug Tracker

Bugs are tracked on GitHub Issues <https://github.com/OCA/rest-framework/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 <https://github.com/OCA/rest-framework/issues/new?body=module:%20base_rest_demo%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>.

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

Credits

Authors

* ACSONE SA/NV

Contributors

• Laurent Mignon laurent.mignon@acsone.eu

Maintainers

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

.. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px
    :target: https://github.com/lmignon
    :alt: lmignon

Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-lmignon| 

This module is part of the `OCA/rest-framework <https://github.com/OCA/rest-framework/tree/13.0/base_rest_demo>`_ project on GitHub.

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