Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fityannugroho/bookshelf-api

Submission kelas back-end pemula dicoding
https://github.com/fityannugroho/bookshelf-api

api backend dicoding dicoding-submission dotenv hapijs nodemon

Last synced: 2 months ago
JSON representation

Submission kelas back-end pemula dicoding

Host: GitHub
URL: https://github.com/fityannugroho/bookshelf-api
Owner: fityannugroho
Created: 2022-04-04T09:22:04.000Z (almost 3 years ago)
Default Branch: master
Last Pushed: 2024-06-25T13:11:43.000Z (7 months ago)
Last Synced: 2024-06-25T14:40:00.462Z (7 months ago)
Topics: api, backend, dicoding, dicoding-submission, dotenv, hapijs, nodemon
Language: JavaScript
Homepage: https://bookshelf-api-dicoding.herokuapp.com/
Size: 126 KB
Stars: 1
Watchers: 0
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Bookshelf API

## Data

API ini akan menyimpan data buku dengan atribut sebagai berikut:

```json
{
"id": "Qbax5Oy7L8WKf74l",
"name": "Buku A",
"year": 2010,
"author": "John Doe",
"summary": "Lorem ipsum dolor sit amet",
"publisher": "Dicoding Indonesia",
"pageCount": 100,
"readPage": 25,
"finished": false,
"reading": false,
"insertedAt": "2021-03-04T09:11:44.598Z",
"updatedAt": "2021-03-04T09:11:44.598Z"
}
```

## API Endpoints

### 1. Menambahkan Buku Baru

```raml
/books
post:
description: Menambahkan buku baru
request:
body:
application/json:
example: |
{
"name": "Buku A",
"year": 2010,
"author": "John Doe",
"summary": "Lorem ipsum dolor sit amet",
"publisher": "Dicoding Indonesia",
"pageCount": 100,
"readPage": 25,
"reading": false
}
responses:
201:
body:
application/json:
example: |
{
"status": "success",
"message": "Buku berhasil ditambahkan",
"data": {
"bookId": "Qbax5Oy7L8WKf74l",
}
}
400:
description: properti `name` kosong
body:
application/json:
example: |
{
"status": "fail",
"message": "Gagal menambahkan buku. Mohon isi nama buku",
}
400:
description: properti `readPage` lebih besar dari `pageCount`
body:
application/json:
example: |
{
"status": "fail",
"message": "Gagal menambahkan buku. readPage tidak boleh lebih besar dari pageCount",
}
500:
description: generic error
body:
application/json:
example: |
{
"status": "error",
"message": "Buku gagal ditambahkan",
}
```

### 2. Menampilkan semua buku

```raml
/books
get:
description: Menampilkan semua buku
responses:
200:
body:
application/json:
example: |
{
"status": "success",
"data": [
{
"id": "Qbax5Oy7L8WKf74l",
"name": "Buku A",
"publisher": "Dicoding Indonesia",
},
{
"id": "1L7ZtDUFeGs7VlEt",
"name": "Buku B",
"publisher": "Dicoding Indonesia",
}
]
}
```

### 3. Menampilkan detail buku

```raml
/books/{bookId}
get:
description: Menampilkan detail buku
responses:
200:
body:
application/json:
example: |
{
"status": "success",
"data": {
"id": "Qbax5Oy7L8WKf74l",
"name": "Buku A",
"year": 2010,
"author": "John Doe",
"summary": "Lorem ipsum dolor sit amet",
"publisher": "Dicoding Indonesia",
"pageCount": 100,
"readPage": 25,
"finished": false,
"reading": false,
"insertedAt": "2021-03-04T09:11:44.598Z",
"updatedAt": "2021-03-04T09:11:44.598Z"
}
}
404:
description: buku tidak ditemukan
body:
application/json:
example: |
{
"status": "fail",
"message": "Buku tidak ditemukan",
}
```

### 4. Mengubah detail buku

```raml
/books/{bookId}
put:
description: Mengubah detail buku
request:
body:
application/json:
example: |
{
"name": "Buku A",
"year": 2010,
"author": "John Doe",
"summary": "Lorem ipsum dolor sit amet",
"publisher": "Dicoding Indonesia",
"pageCount": 100,
"readPage": 25,
"reading": false
}
responses:
200:
body:
application/json:
example: |
{
"status": "success",
"message": "Buku berhasil diperbarui",
}
400:
description: properti `name` kosong
body:
application/json:
example: |
{
"status": "fail",
"message": "Gagal memperbarui buku. Mohon isi nama buku",
}
400:
description: properti `readPage` lebih besar dari `pageCount`
body:
application/json:
example: |
{
"status": "fail",
"message": "Gagal memperbarui buku. readPage tidak boleh lebih besar dari pageCount",
}
404:
description: `id` buku tidak ditemukan
body:
application/json:
example: |
{
"status": "fail",
"message": "Gagal memperbarui buku. Id tidak ditemukan",
}
```

### 5. Menghapus buku

```raml
/books/{bookId}
delete:
description: Menghapus buku
responses:
200:
body:
application/json:
example: |
{
"status": "success",
"message": "Buku berhasil dihapus",
}
404:
description: `id` buku tidak ditemukan
body:
application/json:
example: |
{
"status": "fail",
"message": "Buku gagal dihapus. Id tidak ditemukan",
}
```

## Menjalankan Server

### 1. Konfigurasi server

Dupilkasikan file `.env.example` dan ubah namanya menjadi `.env`. Lalu atur `HOST` dan `PORT` sesuai dengan yang diinginkan.

### 2. Jalankan server

Untuk menjalankan di lingkungan **pengembangan (*development*)**, gunakan perintah:

```bash
$ npm run start:dev
```

Untuk menjalankan di lingkungan **produksi (*production*)**, gunakan perintah:

```bash
$ npm run start:prod
```