Git Product home page Git Product logo

naija-emoji-api's Introduction

StyleCI

NAIJA EMOJI API

##Summary This project is a simple restful Naija Emoji api where authenticated users can fetch, create, delete and update emojis. This api makes use of a token based authentication system.

##Usage User login

Send a post request to http://bd-naijaemoji.herokuapp.com/auth/login with post data username and password

curl -i -X POST -H 'Content-Type: application/x-www-form-urlencoded' -d '{"username": "your username", "password": "your password"}' http://bd-naijaemoji.herokuapp.com/auth/login

User Logout

Send a get request to http://bd-naijaemoji.herokuapp.com/auth/logout with the user token in the header

curl -i -X GET -H 'user-token: user_token' http://bd-naijaemoji.herokuapp.com/auth/login

Create Emoji

Send a post request to http://bd-naijaemoji.herokuapp.com/emojis with the emoji data passed via post and the user token passed in the headers

curl -i -X POST -H 'Content-Type: application/x-www-form-urlencoded, user-token: user_token' -d 
'{
"name": "smiley name", 
"smiley": "smiley character",
"category": "smiley category",
"keywords": "smiley keywords",
}'
http://bd-naijaemoji.herokuapp.com/emojis

Update Emoji

Send a put or patch request to http://bd-naijaemoji.herokuapp.com/emojis/{emoji_id} with the emoji data passed via post and the user token passed in the headers

curl -i -X PUT/PATCH -H 'Content-Type: application/x-www-form-urlencoded; user-token: user_token' -d 
'{
"name": "smiley name", 
"smiley": "smiley character",
"category": "smiley category",
"keywords": "smiley keywords",
}'
http://bd-naijaemoji.herokuapp.com/emojis/{emoji_id}

Delete Emoji

Send a delete request to http://bd-naijaemoji.herokuapp.com/emojis/{emoji_id} with the user token passed in the headers

curl -i -X DELETE -H 'user-token: user_token' http://bd-naijaemoji.herokuapp.com/emojis/{emoji_id}

Fetch All Emojis Send a get request to http://bd-naijaemoji.herokuapp.com/emojis

curl -i -X GET -H 'Content-Type: application/json' http://bd-naijaemoji.herokuapp.com/emojis/

Fetch Emoji by ID Send a get request to http://bd-naijaemoji.herokuapp.com/emojis/{emoji_id}

curl -i -X GET -H 'Content-Type: application/json' http://bd-naijaemoji.herokuapp.com/emojis/{emoji_id}

naija-emoji-api's People

Contributors

bodunadebiyi avatar

Watchers

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