Git Product home page Git Product logo

notes's Introduction

Notes Api

Setup:

git clone the repo
Run composer install
$composer install

To setup the environment you need docker.
Create .env file from .env.example file with proper environment variable values
Run below commands..
$docker-compose build //build base container
$docker-compose up -d //build the stack in detached mode
$docker-compose logs -f //monitor logs

To create database and table run sql queries in sql/init.sql

You should have your notes api now accessible at http://localhost:8089/notes

For accessing any api you need basic authentication. You can use the example user credentials...
[email protected]/test

See below example Curl requests...

Create Note

curl -X POST
http://localhost:8089/notes
-H 'authorization: Basic dGVzdEB0ZXN0LmNvbTp0ZXN0'
-H 'cache-control: no-cache'
-H 'content-type: application/json'
-d '{ "title": "title", "content": "1234" }'

Retrieve a Note

curl -X GET
http://localhost:8089/notes/11
-H 'authorization: Basic dGVzdEB0ZXN0LmNvbTp0ZXN0'
-H 'cache-control: no-cache'
-H 'content-type: application/json'

Update a Note

curl -X PUT
http://localhost:8089/notes/11
-H 'authorization: Basic dGVzdEB0ZXN0LmNvbTp0ZXN0'
-H 'cache-control: no-cache'
-H 'content-type: application/json'
-d '{ "title": "title", "content": "123124" }'

Delete a Note

curl -X DELETE
http://localhost:8089/notes/10
-H 'authorization: Basic dGVzdEB0ZXN0LmNvbTp0ZXN0'
-H 'cache-control: no-cache'
-H 'content-type: application/json'

notes's People

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.