{"id":15710193,"url":"https://github.com/ivanhuay/hiroki","last_synced_at":"2025-04-28T16:24:30.068Z","repository":{"id":33870436,"uuid":"160260858","full_name":"ivanhuay/hiroki","owner":"ivanhuay","description":"create a REST api faster than ever","archived":false,"fork":false,"pushed_at":"2025-01-17T04:00:45.000Z","size":1936,"stargazers_count":13,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-17T22:08:03.470Z","etag":null,"topics":["crud","express","mongoose","node","rest"],"latest_commit_sha":null,"homepage":"https://ivanhuay.github.io/hiroki/","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/ivanhuay.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":"2018-12-03T22:13:55.000Z","updated_at":"2024-10-12T06:08:31.000Z","dependencies_parsed_at":"2024-03-19T03:27:10.125Z","dependency_job_id":"d8437b91-a051-41d4-90fe-c1803ef88096","html_url":"https://github.com/ivanhuay/hiroki","commit_stats":{"total_commits":109,"total_committers":3,"mean_commits":"36.333333333333336","dds":"0.17431192660550454","last_synced_commit":"dda21229917bb5bf8e732f0621b2a92cb5549a98"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanhuay%2Fhiroki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanhuay%2Fhiroki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanhuay%2Fhiroki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ivanhuay%2Fhiroki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ivanhuay","download_url":"https://codeload.github.com/ivanhuay/hiroki/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251260530,"owners_count":21560795,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["crud","express","mongoose","node","rest"],"created_at":"2024-10-03T21:04:27.677Z","updated_at":"2025-04-28T16:24:30.001Z","avatar_url":"https://github.com/ivanhuay.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hiroki\n\n[![NPM version][npm-image]][npm-url] [![CircleCI](https://dl.circleci.com/status-badge/img/circleci/73Gnub9RenZ7Vn7XN2Cq7A/7FichnXE69CYoQzoP7ppAd/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/circleci/73Gnub9RenZ7Vn7XN2Cq7A/7FichnXE69CYoQzoP7ppAd/tree/master)\n\nHiroki helps you build REST APIs faster than ever using open source tools and standards that you and your team already know.\n\n## Table of Contents\n\n- [Documentation](#documentation)\n- [Getting Started](#getting-started)\n  - [Installation](#installation)\n  - [Quick Start](#quick-start)\n- [Configuration](#configuration)\n- [Changelog](#changelog)\n\n## Documentation\n\nFor detailed information, please read our [full documentation](https://ivanhuay.github.io/hiroki/).\n\n## Getting Started\n\n### Installation\n\n```bash\nnpm install --save hiroki\n```\n\n### Quick Start\n\nHere's a basic example of how to create a simple REST API with Hiroki:\n\n```javascript\nconst express = require('express');\nconst hiroki = require('hiroki');\nconst mongoose = require('mongoose');\nconst bodyParser = require('body-parser');\nconst app = express();\n\n// Model definition\nconst UsersSchema = new mongoose.Schema({name: String});\nconst UsersModel = mongoose.model('Users', UsersSchema);\n\n// Importing model\nhiroki.importModel(UsersModel);\n\n// Bodyparser middleware\napp.use(bodyParser.urlencoded({ extended: true }));\napp.use(bodyParser.json());\n\n// API route to pass data to Hiroki\napp.use('/api/*', async (req, res) =\u003e {\n    const path = req.originalUrl;\n    const resp = await hiroki.process(path, {\n        method: req.method,\n        body: req.body\n    });\n    res.status(resp.status || 200).json(resp);\n});\n\napp.listen(8012, () =\u003e console.log('Server running on port 8012'));\n```\n\nNote: This example assumes you have already set up your MongoDB connection.\n\n## Configuration\n\nYou can customize Hiroki's configuration, such as changing the base path:\n\n```javascript\nhiroki.setConfig({ \n    basePath: '/api/v2' // default is '/api'\n});\n```\n\n## Changelog\n\n### v2.0.0\n\n- Hiroki is now backend-agnostic. Express has been removed as a dependency.\n- Mongoose version updated.\n- The 'share' feature has been removed. Please check if this impacts your use case.\n\n[Full Changelog](https://ivanhuay.github.io/hiroki/changelog)\n\n[npm-image]: https://badge.fury.io/js/hiroki.svg\n[npm-url]: https://npmjs.org/package/hiroki","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivanhuay%2Fhiroki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fivanhuay%2Fhiroki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fivanhuay%2Fhiroki/lists"}