https://github.com/yohanesokta/hanzsoft-data-api

:stars: api development database hanzsoft | :globe_with_meridians: Public Api
https://github.com/yohanesokta/hanzsoft-data-api

api-rest example expressjs

Last synced: 9 months ago
JSON representation

:stars: api development database hanzsoft | :globe_with_meridians: Public Api

• Host: GitHub
• URL: https://github.com/yohanesokta/hanzsoft-data-api
• Owner: yohanesokta
• Archived: true
• Created: 2023-08-20T15:25:04.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-17T09:32:34.000Z (about 2 years ago)
• Last Synced: 2025-03-01T03:43:11.203Z (11 months ago)
• Topics: api-rest, example, expressjs
• Language: JavaScript
• Homepage: https://hanzsoft-data-api.vercel.app
• Size: 1.77 MB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
api ini difungsikan untuk penggunaan website saya hanzsoft-websites


# :globe_with_meridians: PUBLIC API ( hanzsoft - websites)

penggunaan api ini "Sebenarnya" digunakan untuk website saya pribadi , yaitu hanzsoft-websites. Namun kalian juga bisa pakai untuk metode belajar atau ingin clone dan modifikasi sendiri untuk sebagai referensi.

![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white) ![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)

![Express.js](https://img.shields.io/badge/express.js-%23404d59.svg?style=for-the-badge&logo=express&logoColor=%2361DAFB) ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white) ![JavaScript](https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E)

## BUILD

build sendiri dari data source github 


install package telebih dahulu

    $ git clone https://github.com/yohanesokta/hanzsoft-data-api.git

    $ cd hanzsoft-data-api

    $ npm install

atau bisa pakai yarn

    $ yarn install




    mv .env.example .env

edit _.env_ | isi dengan URI Mongo DB kalian sendiri, bisa bikin di cloud mongodb

| ketentuannya memiliki database utama dan database untuk kategori

running

    npm start || npm run dev

selain run sendiri kalian juga bisa menggunakan api yang sudah di deploy

### | Penggunaan

##### :zap: listen on

    https://hanzsoft-data-api.vercel.app/api

gunakan "/api"!, jangan hanya menggunakan domainya ok :ok_hand:

## Perubahan v1.2

semua berubah di versi 1.2 , perubahan pada response api dan perubahan routes menjadi lebih banyak dan mungkin akan mencakup banyak perubahan

## | Method

### GET METHOD

method ini akan menampilkan hasil yang kalian berikan pada request

method get pada '(url)/api' akan menampilkan semua data tanpa terkecuali

`data pertama ` : data item 


`data kedua ` : data kategori

contoh:

### :page_with_curl: GET

    https://hanzsoft-data-api.vercel.app/api

hasil

```json

{

    "status": {

        "code": 200,

        "type": "success"

    },

    "response": {

        "message": "",

        "count": 1,

        "data": {

            "items": [

                {

                    "_id": "64f490c3c85850613f5c9d29",

                    "nama": "Nama Item",

                    "nama_query": "nama yang digunakan untuk query (pencarian)",

                    "kategori": "kategori",

                    "description": "deskripsi item lebih panjang dari info",

                    "info": "mungkin slogan item atau fungsi item",

                    "icon": "icon image (link)",

                    "download": "download (link)",

                    "ver": "version item",

                    "prev": "preview image(link)",

                    "req": "balum digunakan"

                }

            ],

            "kategori": [

                {

                    "_id": "64f36af16d1389ea75b22f89",

                    "jenis": "Kategori 1",

                    "image": "image (link)"

                },

                {

                    "_id": "64f36b206d1389ea75b22f8a",

                    "jenis": "Kategori 2",

                    "image": "image (link)"

                }

            ]

        }

    }

}

```

## :mag: GET FIND

get find akan menampilkan data sesuai query yang kalian berikan pada url setelah find !

penggunaan

hanzsoft-data-api.vercel.app/api/find/{ query untuk nama software }

**Contoh** :

    https://hanzsoft-data-api.vercel.app/api/find/{ nama software }

contoh untuk find corel

    https://hanzsoft-data-api.vercel.app/api/find/corel

hasil

```json

{

    "status": {

        "code": 200,

        "type": "success"

    },

    "response": {

        "message": "finder data from database by params",

        "count": 1,

        "data": [

            {

                "_id": "64f490c3c85850613f5c9d29",

                "nama": "Corel Draw",

                "nama_query": "corel draw",

                "kategori": "Desain",

                "description": "Corel Draw merupakan salah satu perangkat lunak desain grafis berbasis vektor. Perangkat lunak ini biasanya digunakan oleh seorang desainer grafis untuk mengerjakan pekerjaannya memproduksi berbagai hasil desain dengan basis vektor. Berdiri sejak tahun 1985, terhitung sudah lebih dari 90 juta pengguna menggunakan Corel Draw untuk memenuhi kebutuhan desainnya",

                "info": "populer editing vektor",

                "icon": "https://res.cloudinary.com/dgxbyse13/image/upload/f_auto,q_auto,c_limit,w_200/v1/icon/corel",

                "download": "https://www.mediafire.com/file/id5wbcyaqx5fd8t/Corel_Draw_x7_hanzsoft_data.zip/file",

                "ver": "x7",

                "prev": "https://res.cloudinary.com/dgxbyse13/image/upload/f_auto,q_auto/v1/preview/corel",

                "req": "corel.md"

            }

        ]

    }

}

```

## GET (/api/put)

hampir sama seperti (get find) namun sekarang berada di route (url)/api/put/{nama software spesifik}

**Contoh :**

    https://hanzsoft-data-api.vercel.app/api/put/Corel Draw

harus spesifik karena finder dilakukan pada field nama

**Hasil :**

```json

{

    "status": {

        "code": 200,

        "type": "success"

    },

    "response": {

        "message": "cari data dengan spesifik",

        "count": 1,

        "data": [

            {

                "_id": "64f490c3c85850613f5c9d29",

                "nama": "Corel Draw",

                "nama_query": "corel draw",

                "kategori": "Desain",

                "description": "Corel Draw merupakan salah satu perangkat lunak desain grafis berbasis vektor. Perangkat lunak ini biasanya digunakan oleh seorang desainer grafis untuk mengerjakan pekerjaannya memproduksi berbagai hasil desain dengan basis vektor. Berdiri sejak tahun 1985, terhitung sudah lebih dari 90 juta pengguna menggunakan Corel Draw untuk memenuhi kebutuhan desainnya",

                "info": "populer editing vektor",

                "icon": "https://res.cloudinary.com/dgxbyse13/image/upload/f_auto,q_auto,c_limit,w_200/v1/icon/corel",

                "download": "https://www.mediafire.com/file/id5wbcyaqx5fd8t/Corel_Draw_x7_hanzsoft_data.zip/file",

                "ver": "x7",

                "prev": "https://res.cloudinary.com/dgxbyse13/image/upload/f_auto,q_auto/v1/preview/corel",

                "req": "corel.md"

            }

        ]

    }

}

```

## Penambahan Software Secara Private

GUI Add software telah ditambahkan dalam versi ini di enpoint Add Items GUI

penambahan tersedia pada endpoint

    https://hanzsoft-data-api.vercel.app/api/add/action

_Requires Validation_ kalau mau menambahkan list software

| request parameter| type |

|--|--|

|`nama`| _string_|

|`kategori`| _string_|

|`description`| _string_|

|`info`|_string_ & **short**|

|`icon`|_image link_|

|`download`|**download link**|

|`ver`|_version number_|

|`prev`| _image link_|

|`req`| _system requirements_

info akan direplace dengan description kalau tidak di isi

## Project12 ( + ) Apa itu?

Disini saya telah menambahkan property project12 untuk project [EastJavaCulture](https://github.com/yohanesokta/EastJava-Culture)

Endpoint (Get & Post )

    /project12/Comment

hanya berfungsi sebagai penampung komentar untuk project [EastJavaCulture](https://github.com/yohanesokta/EastJava-Culture)

#### USAGE

| request body | type             |

| ------------ | ---------------- |

| `quest`      | _quest key_      |

| `nama`       | _string nama_    |

| `date`       | _string tanggal_ |

| `time`       | _string waktu_   |

| `field`      | _isi comment_    |

| `image`      | _isi image_      |

note : ini hanya dibutuhkan di post request untuk nambah data

## :anchor: Penutup

Saya **YohanesOktanio** mengharapkan kalian sebagai para developer ikut berkontribusi atau pun mengoreksi project saya ini

sebenarnya masih terdapat banyak fungsi namun masih di tahap pengembangan

Saya YohanesOktanio , follow my github & stay creative :blush: