Giter VIP home page Giter VIP logo

cizo's Introduction

Welcome to Cizo ๐Ÿ‘‹

Version License: ISC Twitter: realhenil

REST API Integration made easy

๐Ÿ  Homepage

Install

npm install cizo

Ideology

This library aims to simplify how client side applications interects with backend REST APIs. Cizo uses object oriented approach to interect with REST API.

Quick Start

server-side

On the Server side you will have to open a public end-point at /_cizo-schema (however, you can custumize this on client-side). This open endpoint should send JSON Schema something like this:

{
    "version": "0.1.0",
    "endpoints": [
        {
            "path": "/hello-world",
            "name": "HelloWorld",
            "methods": "any"
        },
        {
            "path": "/other",
            "name": "other",
            "methods": ["GET", "POST"]
        }
    ]
}

client-side

import CizoClient from 'cizo';

const cizo = new CizoClient({
    host: 'http://localhost:3000', // default
    endpoint: '/_cizo-schema' // default
})

await cizo.init() // this is required to fetch schema

// Performing a query
cizo.get('HelloWorld').then(console.log).catch((error)=>{
    console.error("Error", error)
})

Author

๐Ÿ‘ค Henil Malaviya

๐Ÿค Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a โญ๏ธ if this project helped you!

cizo's People

Contributors

henil0604 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.