Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 3.99 KB

README.md

File metadata and controls

62 lines (43 loc) · 3.99 KB
Raw



Mockoon's Playground

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.

➡️ Playground API URL: https://playground.mockoon.com ➡️ Playground's documentation

The playground offers the following resources, populated with fake data (generated using Faker.js):

  • /contacts: a CRUD endpoint with fake contacts.
  • /movies: a CRUD endpoint with fake movies.
  • /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.

The following routes are available for each resource:

  • 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.

You can also use the sorting, searching and filtering query parameters on the main GET route, example: ?property_eq=test&page=2&limit=50. You will find more information about the CRUD routes behavior in our documentation.

💡 The following routes are disabled: DELETE /resources, PATCH /resources, PUT /resources. POST, DELETE, PATCH and PUT requests are persisted. GET requests are cached.

⚠️ The playground is a shared resource (please don't abuse it) and is not meant to be used in production. Data are frequently reset.

To go further, download Mockoon and discover all its features.

➡️ Download Mockoon

Support/feedback

You can discuss all things related to Mockoon, and ask for help, on the official community. It's also a good place to discuss bugs and feature requests before opening an issue on this repository. For more chat-like discussions, you can also join our Discord server.

Contributing

If you are interested in contributing to Mockoon, please take a look at the contributing guidelines.

Please also take a look at our Code of Conduct.

Roadmap

If you want to know what will be coming in the next release you can check the global Roadmap.

New releases will be announced on Mockoon's Twitter account @GetMockoon and through the newsletter to which you can subscribe here.