https://github.com/kevin-umali/novel-api

Light, Wuxia and Web Novel REST API
https://github.com/kevin-umali/novel-api

api light-novel light-novel-api lightnovel novel rest-api webnovel webnovel-api wuxia wuxia-api

Last synced: about 8 hours ago
JSON representation

Light, Wuxia and Web Novel REST API

• Host: GitHub
• URL: https://github.com/kevin-umali/novel-api
• Owner: Kevin-Umali
• Created: 2020-10-12T04:50:59.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-03-06T15:40:42.000Z (9 months ago)
• Last Synced: 2024-03-06T17:23:38.953Z (9 months ago)
• Topics: api, light-novel, light-novel-api, lightnovel, novel, rest-api, webnovel, webnovel-api, wuxia, wuxia-api
• Language: TypeScript
• Homepage: https://novelpulse.online/documentation
• Size: 2.6 MB
• Stars: 24
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Novel API - Enhanced Edition

![Node](https://img.shields.io/badge/Node-v20.9.0-blue?style=for-the-badge)

![Fastify](https://img.shields.io/badge/Fastify--blue?style=for-the-badge)

![Puppeteer](https://img.shields.io/badge/Puppeteer--blue?style=for-the-badge)

![Zod](https://img.shields.io/badge/Zod--blue?style=for-the-badge)

**An upgraded REST API for light, wuxia, and web novels, now powered by Fastify and Puppeteer for improved performance and reliability. Designed for educational and study purposes, this project showcases advanced web scraping, API development, and data validation techniques.**

## What's New in the Enhanced Edition

- **Upgraded Tech Stack**: Transitioned from Express to Fastify for faster, more efficient server handling.

- **Advanced Scraping with Puppeteer**: Utilizes Puppeteer for enhanced data scraping capabilities, ensuring accurate and up-to-date novel information.

- **Improved Data Validation with Zod**: Incorporates Zod for robust data validation and schema management, enhancing data integrity.

- **Optimized Performance**: Achieves significant performance improvements, offering a smoother and faster user experience.

## Available Sources

We are continuously expanding this library. Here are the current supported sources:

| Site                       | Can Search | Status |

| -------------------------- | :--------: | :----: |

| http://boxnovel.com/       |     ✔     |   ✔   |

| https://wuxiaworld.site/   |     ✔     |   ✔   |

| https://www.royalroad.com/ |            |   ⌛   |

| https://novelfull.com/     |            |   ⌛   |

| https://novelnext.com/     |            |   ⌛   |

## Disclaimer and Purpose

This project and all associated code and documentation are intended **solely for educational and study purposes**. It serves as a practical example of web scraping, API design, and data handling techniques. It is not intended for commercial use or deployment in production environments. The creators and contributors assume no liability for any misuse of the project or any damages resulting from its use. Users are expected to adhere to these guidelines and use the project responsibly.

## Legacy Version

Version 1 (v1) of the API remains accessible and functional, with documentation available at: [Novel API v1](https://github.com/Kevin-Umali/novel-api/tree/v1). Note: v1 may not receive updates or feature enhancements available in the latest version. Users are encouraged to migrate to the current version for the most up-to-date features and improvements.

## Contribute

We welcome contributions! If you've found a bug or have a feature request, feel free to open an issue or submit a pull request on our [GitHub repository](https://github.com/Kevin-Umali/novel-api/issues).