Skip to content

FIJee/Tgss

Repository files navigation

Project: Chall DOT

📁 Collection: Auth

Welcome to the Chall DOT API documentation!

Made with ❤️ by Hafis Rabbani

Pattern: Controller-Service-Repository (CSR) Pattern

Menggunakan pola (pattern) Controller-Service-Repository dalam pengembangan aplikasi web memiliki banyak manfaat, di antaranya:

  1. Memisahkan kode ke dalam lapisan yang terpisah: Dengan memisahkan kode ke dalam lapisan terpisah, struktur aplikasi menjadi lebih teratur dan mudah dipelihara. Controller bertanggung jawab untuk menangani request dan memberikan respon, Service bertanggung jawab untuk logika bisnis, dan Repository bertanggung jawab untuk mengakses data.

  2. Menjaga pemisahan antara logika bisnis dan akses data: Dengan memisahkan kode ke dalam lapisan terpisah, logika bisnis tidak tercampur dengan logika akses data. Dalam Service, developer dapat menulis logika bisnis tanpa memikirkan bagaimana data diambil atau disimpan. Dalam Repository, developer dapat menulis kode untuk mengambil atau menyimpan data tanpa memikirkan bagaimana data tersebut akan digunakan.

  3. Memudahkan dalam pengujian: Memisahkan kode ke dalam lapisan terpisah membuat pengujian menjadi lebih mudah. Dalam Service, developer dapat menulis pengujian untuk logika bisnis tanpa harus memikirkan bagaimana data diambil atau disimpan. Dalam Repository, developer dapat menulis pengujian untuk akses data tanpa harus memikirkan bagaimana data tersebut akan digunakan.

  4. Mudah dalam mengganti teknologi: Dalam Repository, developer dapat mengganti teknologi yang digunakan untuk akses data tanpa harus merubah logika bisnis dalam Service. Dalam Service, developer dapat mengganti teknologi yang digunakan untuk logika bisnis tanpa harus merubah kode dalam Controller.

Dalam keseluruhan, penggunaan pola Controller-Service-Repository dapat meningkatkan modularitas dan memudahkan pemeliharaan, mengurangi ketergantungan antar bagian kode, dan memudahkan dalam pengujian serta dalam mengganti teknologi yang digunakan dalam aplikasi web.

Documentation

End-point: Login

Method: POST

localhost:5000/auth/login

Body (raw)

{
    "email": "hafis.gov@gmail.com",
    "password": "12345678"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

End-point: Me

Method: GET

{{host}}/auth/me

Headers

Content-Type Value
Bearer

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

End-point: Register

Method: POST

{{host}}/auth/register

Body (raw)

{
    "full_name": "HafizR",
    "email": "test@testing.com",
    "password": "123456"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Collection: Category

End-point: Find All

Method: GET

{{host}}/categori/

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

End-point: Create

Method: POST

{{host}}/categori/create

Body (raw)

{
    "name": "Testing"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

End-point: Delete

Method: DELETE

localhost:5000/categori/delete/1

Body (raw)

🔑 Authentication bearer

Param value Type
token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiaWF0IjoxNjgzMzAwNjc0LCJleHAiOjE2ODMzODcwNzR9.xIXfYaX2vbw-xz0cprnrh5nzlKmA3JGa8XkEFDZKP3E string

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

End-point: Update

Method: PUT

{{host}}/category/update/5

Body (raw)

{
    "name": "testing update"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

📁 Collection: Task

End-point: Create

Method: POST

{{host}}/task/create

Body (raw)

{
    "category_id": 5,
    "task_name": "testing",
    "description": "lorem ipsumawdwaddadadw"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

End-point: Find All

Method: GET

{{host}}/task/

Body (raw)

{
    "category_id": 5,
    "task_name": "testing",
    "description": "lorem ipsum"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

End-point: Update

Method: PUT

{{host}}/task/update/

Body (raw)

{
    "category_id": 6,
    "task_name": "updated",
    "description": "lorem ipsum dolor sit amet"
}

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃

End-point: Delete

Method: DELETE

{{host}}/task/delete/2

⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃ ⁃


Powered By: postman-to-markdown

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors