Git Product home page Git Product logo

members-api's Introduction

Installation

  • git clone https://github.com/jomwebjohor/members-api.git member
  • cd member
  • composer install

Database

  • SQLite

Steps

  • Head to http://localhost/member/jwj to request token
  • Sends the token in Authorization header

API

  • POST /api/members
    • name is required
    • location is required
    • position is optional
    • company is optional
    • skills is optional, comma separated e.g PHP,Ruby,Python
    • facebook is optional
    • twitter is optional
    • github is optional
    • telegram is optional
  • PUT /api/members/{id}
    • name is optional
    • location is optional
    • position is optional
    • company is optional
    • skills is optional
    • facebook is optional
    • twitter is optional
    • github is optional
    • telegram is optional
  • GET /api/members/{username}
    • username will try to search from member name, facebook, twitter, github & telegram username

Responses

  • 200 OK
{
    "name": "Salahuddin Hairai",
    "location": "Kg Melayu Majidee, JB",
    "position": "Software Engineer",
    "company": "Financio Sdn Bhd",
    "skills": [
        "PHP",
        "Laravel",
        "Phalcon",
        "Symfony",
        "CodeIgniter"
    ],
    "social": {
        "facebook": {
            "username": "salahuddin.hairai",
            "uri": "https://facebook.com/salahuddin.hairai"
        },
        "twitter": {
            "username": "od3n",
            "uri": "https://twitter.com/od3n"
        },
        "github": {
            "username": "od3n",
            "uri": "https://github.com/od3n"
        },
        "telegram": "od3n87"
    },
    "error": false,
    "status": 200
}
  • 400 Bad Request
{
  "error": true,
  "msg": "Invalid name.",
  "status": 400
}
{
  "error": true,
  "msg": "Error occured while trying to save the record.",
  "status": 400
}
  • 401 Unauthorized

null

members-api's People

Contributors

od3n avatar 3ub41r avatar

Watchers

Kamal Mustafa avatar James Cloos 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.