https://github.com/xurei/restgoose
Model-driven REST API framework using decorators
https://github.com/xurei/restgoose
api back-end decorators framework mongodb mongoose nodejs rest restful-api typescript
Last synced: 12 months ago
JSON representation
Model-driven REST API framework using decorators
- Host: GitHub
- URL: https://github.com/xurei/restgoose
- Owner: xurei
- License: apache-2.0
- Created: 2018-08-24T14:55:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T11:20:54.000Z (about 1 year ago)
- Last Synced: 2025-03-11T12:27:31.968Z (about 1 year ago)
- Topics: api, back-end, decorators, framework, mongodb, mongoose, nodejs, rest, restful-api, typescript
- Language: TypeScript
- Homepage: https://xurei.github.io/restgoose
- Size: 630 KB
- Stars: 28
- Watchers: 5
- Forks: 2
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: docs/roadmap.md
Awesome Lists containing this project
README
# Restgoose
Modern REST API framework. [https://xurei.github.io/restgoose](https://xurei.github.io/restgoose/)
[](https://www.npmjs.com/package/@xureilab/restgoose)
[](https://app.wercker.com/project/byKey/8ae5627cc2fb406638c44d6784b02815)
[](https://codecov.io/gh/xurei/restgoose)
[](https://www.codacy.com/app/xurei/restgoose?utm_source=github.com&utm_medium=referral&utm_content=xurei/restgoose&utm_campaign=Badge_Grade)
[](https://bestpractices.coreinfrastructure.org/projects/2181)
[](https://npms.io/search?q=%40xureilab%2Frestgoose)
[](https://www.reddit.com/r/restgoose)
[](https://app.wercker.com/project/byKey/8ae5627cc2fb406638c44d6784b02815)
#### MongoDB + Typescript + Restgoose = ❤️️
Restgoose exposes your MongoDB database through a REST API with ease.
It is driven by the model itself, which reduces the boilerplate code necessary to write simple endpoints.
It is open for extension, so you can add complex logic easily too.
## Installation
```bash
npm install @xureilab/restgoose
```
## Minimal usage
This creates the typical CRUD endpoints on a model :
```typescript
import { Restgoose, RestgooseModel, all, create, one, prop, remove, rest, update } from '@xureilab/restgoose';
@rest({
route: '/todos',
methods: [
all(), // GET /todos
one(), // GET /todos/:id
create(), // POST /todos
update(), // PATCH /todos/:id
remove(), // DELETE /todos/:id
],
})
export class Todo extends RestgooseModel {
@prop({required: true})
name: string;
}
```
See the full example (with express/mongoose boilerplates) [in the examples directory](./examples)
Check out [the docs](https://xurei.github.io/restgoose/) for details.
## The Philosophy behind Restgoose
Restgoose takes its inspiration from Typegoose and Loopback.
We also had some objectives in mind while writing Restgoose :
- Simple, common behaviors should be really easy to write,
- The framework should follow a RESTful design,
- The framework should be simple to add in an existing project,
- While promoting some best practices, the framework should let the user add
complex endpoints without Restgoose if necessary
- The framework should be small and provide as little middlewares as necessary.
Plugins will be created for better cherry-picking.
## Contribute
We are looking for collaborators to test the framework in real-world situations, and also make the development faster.
Check out the [roadmap](https://xurei.github.io/restgoose/roadmap.html) to see what's going on.
## Community
Reddit: [https://www.reddit.com/r/restgoose/](https://www.reddit.com/r/restgoose/)
## Support on Beerpay
[](https://beerpay.io/xurei/restgoose)
[](https://beerpay.io/xurei/restgoose?focus=wish)