Giter Club home page Giter Club logo

extendapi's Introduction

ExtendAPI

A example to utilize the OSSN RESTful API, it extends the existing API feature and add custom method to system This component add custom api method (my_custom_end_point) that can be called following way :

CURL https://www.mywebsite.com/api/v1.0/my_custom_end_point?api_key_token=<my_api_key_token>

The output is simply the comparing two static variables and display api response.

You can edit this component and add more methods by simply adding below in function my_custom_end_point_register in file components/ExtendAPI/ossn_com.php

$methods['v1.0'][] = 'custom_method_second';

Once you added you need to create a file in components/ExtendAPI/plugins/default/services/v1.0/custom_method_second.php

Set success and error response

To set success response use following :

$params['OssnServices']->successResponse("My message for success goes here");	

For error:

$params['OssnServices']->throwError('200', "Error response here"); //don't change 200 error code,  in case you want to have own error code , you may change it with your own custom error code.

extendapi's People

Contributors

lianglee avatar

Stargazers

 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.