Smile API Rest

This module provisions you with an API which allows you to access models through HTTP requests.

Documentation generate with Swagger OpenAPI Specification - Version 2.0 (https://swagger.io/specification/v2/)

Table of contents

• Requirements
• Usage
  • Documentation URIs
  • API URIs
  • Error response
• Bug Tracker
• Credits
  • Contributors
  • Maintainer

Requirements

There are no requirements to use this module.

Usage

Documentation URIs

URI	Description
/<api-docs>/v<api_version>	API Documentation (generate with swagger)
/<api-docs>/v<api_version>/swagger.json	Json Swagger

API URIs

URI	Method	Description
/<api>/v<api_version>/<api_name>	GET	Read all (with optional domain, fields, offset, limit, order)
/api/v<api_version>/<api_name>/<id>	GET	Read one (with optional fields)
/api/v<api_version>/<api_name>	POST	Create a record
/api/v<api_version>/<api_name>/<id>	PUT	Update a record
/api/v<api_version>/<api_name>/<id>	DELETE	Delete a record
/api/v<api_version>/<api_name>/custom	PUT	Call method (with optional parameters)
/api/v<api_version>/<api_name>/custom/<id>	PUT	Call method on record (with optional parameters)

Error response

{
    'code': <code>  # Error code,
    'error': <error>  # Error name,
    'description': <description>  # Description of the error,
}

Bug Tracker

Bugs are tracked on GitHub 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 here.

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

Credits

Contributors

• Corentin POUHET-BRUNERIE
• Julien DRECQ

Maintainer

This module is maintained by Smile SA.

Since 1991 Smile has been a pioneer of technology and also the European expert in open source solutions.