From f2c9b710a52b5267ed97455fc6d1e1d5533a32b8 Mon Sep 17 00:00:00 2001 From: Febry Ardiansyah <33514300+febryardiansyah@users.noreply.github.com> Date: Sun, 26 Jul 2020 20:01:36 +0700 Subject: [PATCH] added documentation --- README.md | 75 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 57 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 06c37d7..2babdf1 100644 --- a/README.md +++ b/README.md @@ -14,28 +14,67 @@ Restful API Manga bahasa Indonesia built with ❤️ and node.js 4. visit http://localhost:3000/api # Documentation -__API__ __PATH__ = http://localhost:3000/api -__ApI__ Version = `v1.0` +__API__ __PATH__ = https://mangamint.glitch.me/api/ +
__ApI__ Version = `v1.0` -## Get All Manga +## All Manga Get Latest Manga Update +``` +/manga/page/[pagenumber] +``` +example : https://mangamint.glitch.me/api/manga/page/1 + +## Popular Manga +Get Popular Manga +``` +/manga/popular/[pageNumber] +``` +example : https://mangamint.glitch.me/api/manga/popular/1 + +## Detail Manga +``` +/manga/detail/[endpoint] +``` +example : https://mangamint.glitch.me/api/manga/detail/after-transformation-mine-and-her-wild-fantasy/ + +## Search Manga by Name +``` +/cari/[query] +``` +example : https://mangamint.glitch.me/api/cari/komi%20san + +## Genre List +``` +/genres +``` +example : https://mangamint.glitch.me/api/genres + +## Genre Detail +``` +/genres/[endpoint]/[pagenumber] +``` +example : https://mangamint.glitch.me/api/genres/action/1 + +## Recomended Manga +``` +/recomended +``` +example : https://mangamint.glitch.me/api/recomended + +## Manhua List (Chinese Comic) +``` +/manhua/[pageNumber] +``` +example : https://mangamint.glitch.me/api/manhua/1 -```bash -/manga/page/[pageNumber] +## Manhwa List (Korean Comic) +``` +/manhwa/[pageNumber] ``` +example : https://mangamint.glitch.me/api/manhua/1 -Returns +## Chapter ``` -bash -{ -manga_list: [ - { - title: "My Wife is a Demon Queen ", - thumb: "https://i0.wp.com/komiku.co.id/wp-content/uploads/Manhua-My-Wife-is-a-Demon-Queen.jpg?resize=450,235&quality=60", - type: "Manhua", - updated_on: "2 jam lalu Berwarna", - endpoint: "my-wife-is-a-demon-queen/", - chapter: "Chapter 212" - }, -] +/chapter/[chapterEndpoint] ``` +example : https://mangamint.glitch.me/api/chapter/after-transformation-mine-and-her-wild-fantasy-chapter-70-bahasa-indonesia/