Skip to content

Commit

Permalink
Add more resources
Browse files Browse the repository at this point in the history
  • Loading branch information
255kb committed Dec 18, 2023
1 parent b81cf28 commit 81f4d7e
Show file tree
Hide file tree
Showing 2 changed files with 518 additions and 25 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,34 @@

Mockoon's playground is a ready-to-use mock API for all your prototyping needs: fake JSON data, JSON placeholders, realistic CRUD API mock, etc. It is also a good way to discover Mockoon's features.

The playground offers the following routes, populated with fake data (generated using [Faker.js](https://fakerjs.dev/)):
➡️ Playground API URL: [https://playground.mockoon.com](https://playground.mockoon.com)
➡️ [Playground's documentation](https://mockoon.com/playground/)

- `/posts`: a CRUD endpoint with 100 fake posts
- `/users`: a CRUD endpoint with 100 fake users
The playground offers the following resources, populated with fake data (generated using [Faker.js](https://fakerjs.dev/)):

➡️ Playground API URL: [https://playground.mockoon.com](https://playground.mockoon.com)
➡️ [Playground's website](https://mockoon.com/playground/)
- `/photos`: a CRUD endpoint with fake photos.
- `/posts`: a CRUD endpoint with fake posts.
- `/todos`: a CRUD endpoint with fake todos.
- `/users`: a CRUD endpoint with fake users.

To go further, download Mockoon and discover all its [features](https://mockoon.com/features/).
The following routes are available for each resource:

➡️ [Download Mockoon](https://mockoon.com/download/)
- `GET /resources`: Returns the entire array
- `GET /resources/:id`: Returns an object by its id property
- `POST /resources`: Inserts a new object in the array (autogenerate the id (UUID) if not provided)
- `PUT /resources/:id`: Performs a full object update by its id (replace)
- `PATCH /resources/:id`: Performs a partial object update by its id (merge)
- `DELETE /resources/:id`: Deletes an object by its id

## Mockoon's documentation
You can also use the `sort`, `order`, `limit` and `page` query parameters. You will find more information about the CRUD routes behavior in our [documentation](https://mockoon.com/docs/latest/api-endpoints/crud-routes/).

You will find Mockoon's [documentation](https://mockoon.com/docs/latest) on the official website. It covers Mockoon's most complex features. Feel free to contribute or ask for new topics to be covered.
> 💡 The following routes are disabled: `DELETE /resources`, `PATCH /resources`, `PUT /resources`. POST, DELETE, PATCH and PUT requests are persisted. GET requests are cached.
## Changelogs
> ⚠️ The playground is a shared resource (please don't abuse it) and is not meant to be used in production. Data are frequently reset.
You will find Mockoon applications [changelogs](https://mockoon.com/releases/) on the official website.
To go further, download Mockoon and discover all its [features](https://mockoon.com/features/).

➡️ [Download Mockoon](https://mockoon.com/download/)

## Support/feedback

Expand Down
512 changes: 498 additions & 14 deletions dist/playground-mock.json

Large diffs are not rendered by default.

0 comments on commit 81f4d7e

Please sign in to comment.