Skip to content
vigneshsb403Public

About

API for notes app (or) website in PHP

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notes-API

Install • Usage • Auth • Folder • Note



Installing

First clone the repo

git clone https://github.com/vigneshsb403/Notes-API/

then run the below commands:

cd Notes-API
docker compose build
docker compose up -d

Note

Assuming you have installed docker.

Usage

To test if every thing is working Request:

curl --location --request POST 'http://localhost/api/test'

Response:

{
    "Host": "localhost",
    "User-Agent": "curl\/8.1.2",
    "Accept": "*\/*"
}



Auth

Signup

Request:

curl --location 'http://localhost/api/auth/signup' \
--form 'username="root"' \
--form 'email="rioot57@icloud.com"' \
--form 'password="dontlookhere"'

Response:

{
    "message": "Signup success",
    "userid": 116
}

Login

Request:

curl --location 'http://localhost/api/auth/login' \
--form 'username="root"' \
--form 'password="dontlookhere"'

Responce:

{
    "message": "Login success",
    "tokens": {
        "access_token": "a.9f0e77f9b08bbe258f4df61cc4e3e1c180f6f3c6e881a8c74f87XXXXXXXXXXXX",
        "valid_for": 7200,
        "refresh_token": "r.ee4fbd66283e64f2ee8fe75ef233a03b576f4e2e302e80ff5feXXXXXXXXXXXX",
        "reference_token": "auth_grant",
        "type": "api"
    }
}

Refresh Token

Request:

curl --location 'http://localhost/api/auth/refresh' \
--form 'refresh_token="r.5e2653b4b1995fdb7490fa01cc8fce46955892efb95d0df3b225XXXXXXXXXXXX"'

Responce:

{
    "message": "Refresh Success",
    "tokens": {
        "access_token": "a.62761edb7a664521104187ad3308b983f92711c973ff3d77cXXXXXXXXXXXX",
        "valid_for": 7200,
        "refresh_token": "d.17ab0606e7e0ff47b96XXXXXXXXXXXX",
        "reference_token": "r.5e2653b4b1995fdb7490fa01cc8fce46955892efb95d0df3b2XXXXXXXXXXXX",
        "type": "api"
    }
}

Current user

Request:

curl --location --request POST 'http://localhost/api/auth/current' \
--header 'Authorization: Bearer a.8e640f40e87cd18cf2052f7f69bc2cff8c5a1393d3866beaXXXXXXXXXXXX' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4nXXXXXXXXXXXX'

Responce:

{
    "username": "root"
}

Note

you also get a cookie with the responce




Folder

New Folder

Request:

curl --location 'http://localhost/api/folder/new' \
--header 'Authorization: Bearer a.8e640f40e87cd18cf2052f7f69bc2cff8c5a1393d3866bea54c0e081f6b2f5e2' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4n4kpa7jt17kj3h' \
--form 'name="ANSI Hacking"'

Responce:

{
    "folder_id": 14
}

List Folder

Request:

curl --location 'http://localhost/api/folder/list' \
--header 'Authorization: Bearer a.8e640f40e87cd18cf2052f7f69bc2cff8c5a1393d3866bea54c0e081f6b2f5e2' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4n4kpa7jt17kj3h'

Responce:

[
    {
        "id": "13",
        "name": "Default Folder",
        "owner": "root",
        "created_at": "2024-01-10 15:38:35",
        "created": "16 hours ago",
        "count": "0"
    },
    {
        "id": "14",
        "name": "ANSI Hacking",
        "owner": "root",
        "created_at": "2024-01-11 08:04:07",
        "created": "1 minute ago",
        "count": "0"
    }
]

Delete Folder:

Request:

curl --location 'http://localhost/api/folder/delete' \
--header 'Authorization: Bearer a.8e640f40e87cd18cf2052f7f69bc2cff8c5a1393d3866bea54c0e081f6b2f5e2' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4n4kpa7jt17kj3h' \
--form 'id="14"'

Responce:

{
    "message": "success"
}

Get all notes

Request:

curl --location 'http://localhost/api/folder/get_all_notes' \
--header 'Authorization: Bearer a.8e640f40e87cd18cf2052f7f69bc2cff8c5a1393d3866bea54c0e081f6b2f5e2' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4n4kpa7jt17kj3h' \
--form 'id="13"'

Response:

{
    "count": "2",
    "notes": [
        {
            "id": "51",
            "title": "New note",
            "body": "new body",
            "created_at": "2024-01-11 08:38:09",
            "updated_at": "2024-01-11 08:38:09",
            "owner": "root",
            "folder_id": "13",
            "created": "2 minutes ago",
            "updated": "2 minutes ago"
        },
        {
            "id": "52",
            "title": "Free note",
            "body": "Never trust user data",
            "created_at": "2024-01-11 08:39:27",
            "updated_at": "2024-01-11 08:39:27",
            "owner": "root",
            "folder_id": "13",
            "created": "55 seconds ago",
            "updated": "55 seconds ago"
        }
    ]
}



Note

New Note

Request:

curl --location 'http://localhost/api/notes/new' \
--header 'Authorization: Bearer a.8e640f40e87cd18cf2052f7f69bc2cff8c5a1393d3866bea54c0e081f6b2f5e2' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4n4kpa7jt17kj3h' \
--form 'title="New note"' \
--form 'body="new body"' \
--form 'folder="13"'

Response:

{
    "note_id": "51"
}

Get Note

Request:

curl --location 'http://localhost/api/notes/get' \
--header 'Authorization: Bearer a.8e640f40e87cd18cf2052f7f69bc2cff8c5a1393d3866bea54c0e081f6b2f5e2' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4n4kpa7jt17kj3h' \
--form 'id="52"'

Response:

{
    "id": "52",
    "title": "Free note",
    "body": "Never trust user data",
    "created": "4 hours ago",
    "updated": "4 hours ago"
}

Edit Note

Request:

curl --location 'http://localhost/api/notes/edit' \
--header 'Authorization: Bearer a.c43164c466a67ce17fbd5d93d7a71595381746e17499b696d0647c316e980543' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4n4kpa7jt17kj3h' \
--form 'id="51"' \
--form 'title="Edited "' \
--form 'body="DNS runs on port 53"'

Response:

{
    "id": "51",
    "title": "Edited",
    "body": "DNS runs on port 53",
    "created": "4 hours ago",
    "updated": "1 second ago"
}

Delete Note

Request:

curl --location 'http://localhost/api/notes/delete' \
--header 'Authorization: Bearer a.c43164c466a67ce17fbd5d93d7a71595381746e17499b696d0647c316e980543' \
--header 'Cookie: PHPSESSID=81pru9ip5gq4n4kpa7jt17kj3h' \
--form 'id="51"'

Response:

{
    "message": "success"
}

Made with 💙 by vignesh sb.

About

API for notes app (or) website in PHP

Topics

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages