https://github.com/feryardiant/apify
Zero-config fake REST API server 🔥
https://github.com/feryardiant/apify
api-service json json-server mock-data mock-server
Last synced: about 1 month ago
JSON representation
Zero-config fake REST API server 🔥
- Host: GitHub
- URL: https://github.com/feryardiant/apify
- Owner: feryardiant
- License: mit
- Created: 2019-03-03T01:55:34.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-30T21:21:27.000Z (8 months ago)
- Last Synced: 2024-10-29T07:23:42.103Z (7 months ago)
- Topics: api-service, json, json-server, mock-data, mock-server
- Language: TypeScript
- Homepage: https://apify.vercel.app/
- Size: 1.17 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Zero-config fake REST API server.
Yet another fake REST API server-based on my own needs. No config, no option, less foot-print, less dependencies and of course less functionalities, LOL. If you wish more robust fake REST API server, please check [json-server](https://github.com/typicode/json-server) by @typicode they've done great job on that project though.
Why don't I use that json-server project instead of create my own, if you ask? Because, why not. Obviously. :grin:
This project is aims to offer similar [response](https://laravel.com/docs/eloquent-resources) and [end-points structures](https://laravel.com/docs/controllers#resource-controllers) provided by laravel
## Limitations
- This project is hosted on [vercel](http://vercel.com)' free plan at the moment. So, all the limitations of free plan are applied, including 1k invocation / day. So, if you find the project is down, that's probably has exceeded max invocation.
- Only supports GitHub repositories
## Getting Started
All you need to do is creating file called `.apify.json` in your root project. Example:
```json
{
"posts": [
{
"id": 1,
"users": {
"username": "john.doe",
"email": "[email protected]",
},
"title": "Foo Bar",
"contents": "Lorem Ipsum ..."
}
],
"albums": [
{
"id": 1,
"title": "Some Pictures",
"images": [
{
"name": "http://lorempixel.com/640/480"
},
{
"name": "http://lorempixel.com/640/480"
}
]
}
]
}
```
Don't forget to commit and push to your github repository, done? now you can access your _fake_ api through URL below:
```
http://apify.vercel.com/:username/:reponame/:table
```
The `:table` is either `posts`, `albums` or `users` from your `.apify.json` file.
That's it 🍻
## Response
As I've already mentioned above this project will have similar response object like Laravel does, which is it will wrapped as `data` and `meta`. No `links` for now. So, if you have example data above and you access `/:username/:reponame/albums` for instance, it will returns like this:
```json
{
"data": [
{
"id": 1,
"title": "Some Pictures"
},
{
"id": 2,
"title": "Another Pictures"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 2,
"primary": "id",
"soft_deletes": true,
"timestamps": true,
"attributes": {
"id": {
"key": "id",
"label": "ID",
"visible": true,
"sortable": true,
"type": "number"
},
"title": {
"key": "title",
"label": "Title",
"visible": true,
"sortable": true,
"type": "text"
}
}
},
}
```
The extra properties on `meta` object are simply because my recent front-end projects are using either [bootstrap-vue](https://bootstrap-vue.js.org/docs/components/table/#fields-column-definitions) or [buefy](https://buefy.org/documentation/table) so I think it would be useful if it has clear meta definition from response, so I don't have to re-parse them in client side.
**NOTE** Might be changed on future releases
## Request
We only support `application/json` and `application/x-www-form-urlencoded` request `Content-Type`, so make suser you've set one of them on your request header.
## Routing
Example above will generate 4 end-points
- `/:username/:reponame/posts`
- `/:username/:reponame/albums` _based on `albums.images` array_
- `/:username/:reponame/users` _based on `posts.users` object_
- `/:username/:reponame/images`
Yes, we'll got extra end-points from any `Array` or `Object` values, that means our example above will become something like this.
```json
{
"posts": [
{
"id": 1,
"users_id": 1,
"title": "Foo Bar",
"contents": "Lorem Ipsum ..."
}
],
"users": [
{
"id": 1,
"username": "john.doe",
"email": "[email protected]",
}
],
"images": [
{
"id": 1,
"albums_id": 1,
"name": "http://lorempixel.com/640/480"
},
{
"id": 2,
"albums_id": 1,
"name": "http://lorempixel.com/640/480"
}
],
"albums": [
{
"id": 1,
"title": "Some Pictures"
}
]
}
```
**NOTE:** Unfortunately the relationship functionality is not fully implemented (yet). :sweat_smile:
All end-points supports `GET`, `POST`, `PUT` and `DELETE`, which is have (almost) the same structure as [laravel resouce controller](https://laravel.com/docs/controllers#resource-controllers). Excepts for `create` and `edit` actions, also no `PATCH`, `HEAD` or `OPTIONS` support yet. Because I don't personally need it, if you ask. :grin:
Also, you might noticed that we convert relation name as is, no plural and singular conversion (yet). So if you have data like this:
```json
{
"people": {
"id": 1,
"name": "John Doe",
"company": {
"name": "Acme Inc."
}
}
}
```
Will become something like this:
```json
{
"people": {
"data": [
{
"id": 1,
"name": "John Doe",
"company_id": 1
}
],
"meta": {}
},
"company": {
"data": [
{
"id": 1,
"name": "Acme Inc."
}
],
"meta": {}
}
}
```
I'll implement this later on, _if needed_
### Pagination
By default all returned data are paginated 15 rows per page and we use `page` and `per_page` query string to do so. Example:
```
/albums?page=2
/albums?page=2&per_page=15
```
**NOTE** Might be changed on future releases
### Ordering
The default ordering is `id, descending`. You're free to change data ordering whatever you like using `sort` key, like this:
```
/api/table?sort=id
// => sort: { id: 'desc' }
/api/table?sort.id
// => sort: { id: 'desc' }
/api/table?sort.id=asc&sort.created_at=asc
// => sort: { id: 'asc', created_at: 'asc' }
/api/table?sort[]=id&sort[]=created_at
// => sort: { id: 'desc', created_at: 'desc' }
/api/table?sort[]=id&sort.created_at=asc
// => sort: { id: 'desc', created_at: 'desc' }
```
### Filtering
**NOT IMPLEMENTED YET**
## Credits
- [json-server](https://github.com/typicode/json-server) by @typicode
## License
MIT - [Fery Wardiyanto](https://github.com/feryardiant)