Git Product home page Git Product logo

odoo-rest-api's Introduction

Odoo REST API Module

This is simple odoo module for REST API

How to run?

  • Fresh Install:

    • docker-compose up -d in your terminal (if you want to run using docker and/or you want to fresh install odoo)
  • Existing Installation

    • move addons/odoo-rest-api into your odoo addons directory (if you have odoo), install in Apps then check the API in GET /api/ping
    • if you have existing odoo in docker and want to install this addons, mount directory addons/odoo-rest-api to odoo image which is running in docker and follow a step above

Endpoint

  • Check if API is working or server is active
    • GET /api/ping
    • GET /api/check
    • GET /api/check/health
    • GET /api/health
  • List of Database in Odoo (which is model in odoo)
    • GET /api/db
    • GET /api/database
  • Authentication and Authorization
    • POST /api/auth/login
    • GET /api/auth/logout
    • POST /api/auth/logout
  • Get Data
    • GET /api/model/:model
    • GET /api/model/:field
    • GET /api/model/:rec_id
    • GET /api/model/:rec_id/:field
  • Post Data
    • POST /api/model/:model
  • Put Data
    • PUT /api/model/:model
    • PUT /api/model/:model/:rec_id
  • Delete Data
    • DELETE /api/model/:model
    • DELETE /api/model/:model/:rec_id

TODOS

  • Create API documentation such as OpenAPI (for JSON) or Swagger UI (for web view)
  • Create unit test
  • Implement more secure Auth such as Session, JWT, OAuth or even SSO
  • Create more endpoint or improve endpoint (right now, i don't have an idea what endpoint should i created)

odoo-rest-api's People

Contributors

emnopal avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.