Merge pull request #1 from erwindosianipar/develop

v1.0.0

CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+API Alkitab Indonesia masih dalam tahap pengembangan dan akan selalu dikembangkan untuk memperbaiki sistem API ini sendiri, berikut adalah beberapa perubahan fitur dan perbaikan-perbaikan yang dilakukan selama pengembangan API ini
+
+## v1.0.0 (24 Oktober 2020)
+
+### Feature
+
+- Passage and Chapter
+Fitur **passage/chapter** adalah fitur untuk membaca bagian alkitab dengan versi bahasa Indonesia
+
+- Passage, Chapter, Number
+Fitur **passage/chapter/number** adalah fitur untuk membaca satu ayat alkitab dengan versi bahasa Indonesia

CONTRIBUTORS.md

@@ -0,0 +1,9 @@
+# Contributors
+
+ Indonesia adalah proyek *open source*. Siapapun bebas untuk berkontribusi di sini, bisa dalam bentuk perbaikan *typo*, update kalimat dalam dokumentasi yang ada. Bagi teman-teman yang berminat ingin berkontribusi silahkan *fork* [https://github.com/erwindosianipar/api-alkitab](https://github.com/erwindosianipar/api-alkitab), kemudian langsung saja buat *issue* dan relevan *pull request* untuk issue tersebut 😊
+
+---
+
+Berikut merupakan list nama kontribusi yang sudah berbaik hati menyisihkan waktunya untuk membantu pengembangan API ini.
+
+- [Erwindo Sianipar](https://erwindosianipar.me)

Procfile

@@ -0,0 +1 @@
+web: bin/api-alkitab

README.md

@@ -1 +1,136 @@
 # API Alkitab Indonesia
+
+## Demo: [https://api-alkitab.herokuapp.com](https://api-alkitab.herokuapp.com)
+
+API Alkitab Indonesia adalah sebuah *third-party backend* Alkitab yang sumber bacaannya berasal dari [sabda.org](https://sabda.org).
+
+[sabda.org](https://sabda.org) adalah sebuah Yayasan Kristen non-profit, non-komersial yang bergerak dalam bidang pelayanan media komputer dan internet di Indonesia.
+
+## Penggunaan
+
+Saat ini (24 Oktober 2020) API masih mempunyai dua fitur utama untuk penampilan pasal dan ayat Alkitab.
+
+### Passage and Chapter
+
+Untuk membaca bagian ayat Alkitab gunakan **passage/{passage}/{chapter}** dengan mengirim nama Ayat dan nomor bagian.
+
+#### Base URL
+
+```bash
+https://api-alkitab.herokuapp.com/v1/passage/{passage}/{chapter}
+```
+
+Variable | Keterangan | Tipe data
+-- | -- | --
+passage | Rentang ayat yang ingin ditampilkan. Menerima berbagai format dalam bahasa Indonesian dan Inggris (Yohanes, Yoh, John, dll). | `string`
+chapter | Adalah nomor pasal/bab yang ingin ditampilkan dari bagian Alkitab | `int`
+
+#### Example
+
+Method | URL
+-- | --
+GET | [https://api-alkitab.herokuapp.com/v1/Yoh/1](https://api-alkitab.herokuapp.com/v1/Yoh/1)
+
+#### Response
+
+```json
+{
+    "message": "success to fetching data",
+    "response": {
+        "title": "Yohanes 1:1-51",
+        "passage": [
+            {
+                "book_id": 43,
+                "title": "Yohanes 1:1-51",
+                "chapter": {
+                    "chap": 1,
+                    "verses": {
+                        "verse": [
+                            {
+                                "number": 1,
+                                "text": "Pada mulanya adalah Firman; Firman itu bersama-sama dengan Allah dan Firman itu adalah Allah."
+                            },
+                            {
+                                "number": 2,
+                                "text": "Ia pada mulanya bersama-sama dengan Allah."
+                            }
+                        ]
+                    }
+                }
+            }
+        ]
+    },
+    "status": 200
+}
+```
+
+### Passage, Chapter, and Number
+
+Untuk membaca satu ayat Alkitab gunakan **passage/{passage}/{chapter}/{number}** dengan mengirim nama Pasal dan nomor bagian dan ayat.
+
+#### Base URL
+
+```bash
+https://api-alkitab.herokuapp.com/v1/passage/{passage}/{chapter}/{number}
+```
+
+Variable | Keterangan | Tipe data
+-- | -- | --
+passage | Rentang ayat yang ingin ditampilkan. Menerima berbagai format dalam bahasa Indonesian dan Inggris (Yohanes, Yoh, John, dll). | `string`
+chapter | Adalah nomor pasal/bab yang ingin ditampilkan dari bagian Alkitab | `int`
+number | Adalah nomor ayat dari bagian pasal/bab yang ingin ditampilkan | `int`
+
+#### Example
+
+Method | URL
+-- | --
+GET | [https://api-alkitab.herokuapp.com/v1/Yoh/1/1](https://api-alkitab.herokuapp.com/v1/Yoh/1/1)
+
+#### Response
+
+```json
+{
+    "message": "success to fetching data",
+    "response": {
+        "title": "Yohanes 1:1",
+        "passage": [
+            {
+                "book_id": 43,
+                "title": "Yohanes 1:1",
+                "chapter": {
+                    "chap": 1,
+                    "verses": {
+                        "verse": [
+                            {
+                                "number": 1,
+                                "text": "Pada mulanya adalah Firman; Firman itu bersama-sama dengan Allah dan Firman itu adalah Allah."
+                            }
+                        ]
+                    }
+                }
+            }
+        ]
+    },
+    "status": 200
+}
+```
+
+### Status Code
+
+API mengembalikan beberapa status code sebagai berikut:
+
+Status Code | Description
+-- | --
+200 | OK
+201 | CREATED
+400 | BAD REQUEST
+404 | NOT FOUND
+500 | INTERNAL SERVER ERROR
+
+### Author
+
+API Alkitab Indonesia ini dibuat oleh **Erwindo Sianipar**. Untuk pertanyaan kritik dan saran, silahkan *drop* email ke [erwindosianipar@gmail.com](mailto:erwindosianipar@gmail.com).
+
+---
+
+> Kemuliaan bagi Tuhan saja - Soli Deo Gloria

config.json

@@ -0,0 +1,7 @@
+{
+    "url" : {
+        "passage" : "http://alkitab.sabda.org/api/passage.php",
+        "chapter" : "http://alkitab.sabda.org/api/chapter.php",
+        "verse" : "http://alkitab.sabda.org/api/verse.php"
+    }
+}

go.mod

@@ -0,0 +1,9 @@
+module api-alkitab
+
+go 1.14
+
+require (
+	github.com/gorilla/mux v1.8.0
+	github.com/sirupsen/logrus v1.7.0
+	github.com/spf13/viper v1.7.1
+)