{"id":28815399,"url":"https://github.com/balxz/sh-api-simple","last_synced_at":"2026-05-04T12:33:18.177Z","repository":{"id":298928116,"uuid":"1001573776","full_name":"balxz/sh-api-simple","owner":"balxz","description":"Free, Fast \u0026 Simple REST API Base Template | AI Integration | Canvas Generation | Auto Swagger Docs | Perfect Starter Kit for Node.js APIs","archived":false,"fork":false,"pushed_at":"2025-06-13T16:40:52.000Z","size":39,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-13T17:32:05.970Z","etag":null,"topics":["2025","ai-integration","api-base","api-template","bot-wa","botwa","express","express-boilerplate","free-api","free-tools","json-api","nodejs","nodejs-backend","rest-api","try","wa-bot","wabot"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/balxz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-13T16:03:28.000Z","updated_at":"2025-06-13T16:54:34.000Z","dependencies_parsed_at":"2025-06-13T17:33:22.109Z","dependency_job_id":"e839319f-e7cd-4399-a5ca-1bfac81ac6d8","html_url":"https://github.com/balxz/sh-api-simple","commit_stats":null,"previous_names":["balxz/sh-api-simple"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/balxz/sh-api-simple","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balxz%2Fsh-api-simple","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balxz%2Fsh-api-simple/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balxz%2Fsh-api-simple/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balxz%2Fsh-api-simple/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/balxz","download_url":"https://codeload.github.com/balxz/sh-api-simple/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balxz%2Fsh-api-simple/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32607540,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["2025","ai-integration","api-base","api-template","bot-wa","botwa","express","express-boilerplate","free-api","free-tools","json-api","nodejs","nodejs-backend","rest-api","try","wa-bot","wabot"],"created_at":"2025-06-18T16:38:24.075Z","updated_at":"2026-05-04T12:33:18.173Z","avatar_url":"https://github.com/balxz.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌸 Shiina API\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://files.catbox.moe/mbeerk.jpg\" alt=\"Shiina API Banner\" width=\"600\"/\u003e\n  \n  \u003cp align=\"center\"\u003e\n    \u003cstrong\u003eA free, simple and elegant REST API created by balxzzy for the common good\u003c/strong\u003e\n  \u003c/p\u003e\n  \n  \u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/version-1.0.0-blue.svg\" alt=\"Version\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/status-online-green.svg\" alt=\"Status\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/node.js-18+-brightgreen.svg\" alt=\"Node.js\"/\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-yellow.svg\" alt=\"License\"/\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003e **The Ultimate Free Node.js REST API Starter Kit** 🚀\n\u003e \n\u003e Perfect base template for building powerful APIs with AI integration, \n\u003e canvas generation, and auto-documentation.\n\n## Why Choose Shiina API Base?\n\n✅ **100% Free \u0026 Open Source**  \n✅ **Production Ready**  \n✅ **AI Integration Built-in**  \n✅ **Auto Swagger Documentation**  \n✅ **Canvas \u0026 Image Generation**  \n✅ **Hot Reload Development**  \n✅ **Zero Configuration Setup**\n\n---\n\n## ✨ Features\n\n- 🤖 **AI Integration** - Powered by LuminAI for smart responses\n- 🎨 **Canvas Generation** - Create beautiful ship cards and graphics\n- 🛠️ **Tools \u0026 Utilities** - Various helpful tools and generators\n- 📚 **Auto Documentation** - Swagger JSON generation\n- 🔄 **Hot Reload** - Automatic updates with nodemon\n- 🌐 **RESTful API** - Clean and simple endpoints\n\n## 🚀 Quick Start\n\n### Prerequisites\n\n- Node.js 18+ \n- npm or yarn package manager\n\n### Installation\n\n```bash\n# Clone the repository\ngit clone https://github.com/balxz/sh-api-simple.git\n\n# Navigate to project directory\ncd sh-api-simple\n\n# Install dependencies\nnpm install\n\n# Start development server\nnode index.js # node .\n```\n\n### Usage\n\n```bash\n# Production mode\nnpm start\n\n# Development mode with hot reload\nnpm run dev\n```\n\nThe API will be available at `http://localhost:3000`\n\n## 📁 Project Structure\n\n```\nshiina-api/\n├── 📄 configs.js          # Global configuration and setup\n├── 📄 index.js            # Main application entry point\n├── 📄 nodemon.json        # Nodemon configuration\n├── 📄 package.json        # Package dependencies\n├── 📂 route/              # API route definitions\n│   ├── 📂 ai/             # AI-related endpoints\n│   │   └── lumini-ai.js   # LuminAI integration\n│   ├── 📂 canvas/         # Image generation endpoints\n│   │   └── ship.js        # Ship card generator\n│   ├── 📂 ex/             # Example endpoints\n│   │   └── example.js     # API usage examples\n│   ├── 📄 index.js        # Route index\n│   └── 📂 user/           # User-related endpoints\n│       └── say.js         # Text generation tools\n└── 📂 src/                # Source code directory\n    ├── 📂 lib/            # Library modules\n    │   ├── 📂 loader/     # Dynamic loaders\n    │   │   ├── docs.js    # Documentation generator\n    │   │   ├── router.js  # Route loader\n    │   │   └── scrap.js   # Scraper loader\n    │   └── 📂 scraper/    # Web scraping modules\n    │       └── 📂 ai/\n    │           └── aites.js # AI scraping utilities\n    └── 📂 pages/          # Static pages\n        ├── 📂 404/        # 404 error page\n        ├── 📄 index.html  # Landing page\n        ├── 📂 maintenance/ # Maintenance page\n        └── 📂 sh/         # Special pages\n```\n\n## 🔗 API Endpoints\n\n### 🤖 AI Services\n- **GET** `/api/ai` - LuminAI chat completion\n  - Parameters: `text` (required)\n  - Example: `/api/ai?text=hello ai!`\n\n### 🎨 Canvas Generation\n- **GET** `/api/canvas/welcome` - Generate ship cards\n  - Description: Create beautiful welcome cards\n\n### 🛠️ Tools \u0026 Utilities\n- **GET** `/api/tools/generate` - Text generation tool\n  - Parameters: `text`, `url`, `size`, `nama`\n  - Example: `/api/tools/generate?text=hello\u0026nama=shiina`\n\n### 📚 Examples\n- **GET** `/example` - Basic API example\n  - Returns sample response structure\n\n## 🔧 Configuration\n\n### Environment Setup\n\nThe API uses global configuration defined in `configs.js`:\n\n```javascript\nconst SH = () =\u003e ({\n    name: \"SH - API\",\n    version: \"1.0.0\",\n    description: \"SHIINA is a free, simple REST API...\",\n    banner: \"https://files.catbox.moe/mbeerk.jpg\",\n    status: \"online\",\n    creator: \"balxzzy\"\n})\n```\n\n### Route Structure\n\nEach route follows this standard format:\n\n```javascript\nmodule.exports = {\n    name: \"route-name\",\n    path: \"/api/endpoint\",\n    type: \"get\", // or \"post\",\n    description: \"Route description\",\n    tags: \"category\",\n    hidden: false,\n    isDisable: false,\n    params: {\n        // Required parameters\n    },\n    code: async (req, res, { axios, scrap }) =\u003e {\n        // Route logic here\n    }\n}\n```\n\n## 📖 Auto Documentation\n\nThe API automatically generates Swagger JSON documentation with:\n- Complete endpoint listing\n- Parameter specifications\n- Response examples\n- Category organization\n- Real-time status updates\n\nAccess the documentation at `http://localhost:3000/` endpoint.\n\n## 🛡️ Security \u0026 Usage\n\n- **Rate Limiting**: Please avoid DDoS attacks\n- **Free Usage**: Available for everyone\n- **Attribution**: Created by balxzzy\n- **Support**: Contact pa424013@gmail.com\n\n## 🤝 Contributing\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 📝 License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## 📞 Contact \u0026 Support\n\n- **Creator**: balxzzy\n- **Email**: pa424013@gmail.com\n- **GitHub**: [@balxz](https://github.com/balxz)\n\n---\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003e\n    \u003cstrong\u003eMade with ❤️ by Shiina Team\u003c/strong\u003e\n  \u003c/p\u003e\n  \n  \u003cp\u003e\n    \u003cem\u003eFeel free to use it, but please use it responsibly!\u003c/em\u003e\n  \u003c/p\u003e\n  \n  \u003cimg src=\"https://files.catbox.moe/mbeerk.jpg\" alt=\"Footer Image\" width=\"400\"/\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbalxz%2Fsh-api-simple","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbalxz%2Fsh-api-simple","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbalxz%2Fsh-api-simple/lists"}