diff --git a/components/nav.tsx b/components/nav.tsx index 88bed17d..b57e3406 100644 --- a/components/nav.tsx +++ b/components/nav.tsx @@ -219,15 +219,6 @@ const Nav: FunctionComponent = function () {
Learn
- - Live Training{' '} - - Docs + Tutorials + + + Live Training{' '} + +
diff --git a/content/compare/mock-service-worker.md b/content/compare/mock-service-worker.md index 3cb8bffb..e7b166ad 100644 --- a/content/compare/mock-service-worker.md +++ b/content/compare/mock-service-worker.md @@ -16,7 +16,7 @@ order: 8 Mock Service Worker (MSW) is a **JavaScript library** that enables developers to **intercept** and **mock** network requests at the browser or Node.js level. It works by creating a service worker that captures outgoing HTTP requests, allowing developers to define custom responses for testing and debugging purposes. MSW is commonly used to simulate API responses during the development process, enabling testing without relying on actual backend services. It supports REST, GraphQL, and other request formats, making it versatile for various use cases in front-end and back-end development. MSW operates as an alternative to other API mocking tools like Mockoon. -![#sub#Screenshot of Mock Service Worker's code](/images/compare/api-mocking-comparison-mock-service-worker-screenshot.png) +![#sub#Screenshot of Mock Service Worker's code{1755x774}](/images/compare/api-mocking-comparison-mock-service-worker-screenshot.png) ## What is Mockoon? diff --git a/content/docs/latest/api-endpoints/crud-routes.md b/content/docs/latest/api-endpoints/crud-routes.md index 04a5887c..e0562423 100644 --- a/content/docs/latest/api-endpoints/crud-routes.md +++ b/content/docs/latest/api-endpoints/crud-routes.md @@ -3,7 +3,7 @@ title: CRUD routes meta: title: Mockoon CRUD routes documentation description: All you need to know about Mockoon's mock API CRUD routes creation, behavior, data bucket operations and data manipulation. -order: 210 +order: 220 --- # CRUD routes @@ -12,7 +12,7 @@ order: 210 ## Overview -Where Mockoon routes are independent and stateless, CRUD routes can generate multiple endpoints to perform CRUD operations (Create, Read, Update, Delete) on [data buckets](docs:data-buckets/overview). Data buckets are generated when the server start, their state persisting between calls. It makes them the perfect tool to simulate small databases. +Where Mockoon routes are [independent and stateless](docs:api-endpoints/http-routes), CRUD routes can generate multiple endpoints to perform CRUD operations (Create, Read, Update, Delete) on [data buckets](docs:data-buckets/overview). Data buckets are generated when the server start, their state persisting between calls. It makes them the perfect tool to simulate small databases. A CRUD endpoint will automatically create a series of routes during runtime, allowing you to perform actions on your data bucket. A typical example is an array of resources (users, invoices, etc.) you can update through a PUT request and see the result in a subsequent GET request. @@ -24,7 +24,7 @@ Then, set its path, usually a [resource name](/articles/api-guide-rest-api-compo ![Set the CRUD route path{1484x176}](docs-img:set-crud-route-path.png) -> Your path can be more complex, and contains parameters or multiple sections. Remember that this will be the "prefix" of the different endpoints (see below). +> 💡 Your path can be more complex, and contains parameters or multiple sections. Remember that this will be the "prefix" of the different endpoints (see below). ## Data bucket link diff --git a/content/docs/latest/api-endpoints/http-routes.md b/content/docs/latest/api-endpoints/http-routes.md new file mode 100644 index 00000000..68dba0e4 --- /dev/null +++ b/content/docs/latest/api-endpoints/http-routes.md @@ -0,0 +1,41 @@ +--- +title: HTTP routes +meta: + title: Mockoon HTTP routes documentation + description: All you need to know about Mockoon's mock API HTTP routes creation, behavior, custom body, headers and more. +order: 210 +--- + +# HTTP routes + +--- + +## Overview + +**HTTP routes** are the most basic **endpoints** you can create in Mockoon. They are flexible and can be used to mock any type of API. They support many customizations like [headers](docs:response-configuration/response-headers) and [body](docs:response-configuration/response-body) and can have [multiple responses](docs:route-responses/multiple-responses) and [rules](docs:route-responses/dynamic-rules) to handle different scenarios. + +To create a new HTTP route, click on the "HTTP route" entry in the add route menu: + +![Add a new HTTP route{498x304}](docs-img:add-http-route.png) + +A new route will be created with a default 200 status code and an empty body. You can then customize it to fit your needs. + +![view of a new HTTP route{1484x476}](docs-img:new-http-route.png) + +## Independence and statelessness + +All HTTP routes are **independent** of each other and **stateless**. It means that HTTP routes will **not share any data** with other routes and that the route will **not remember any information** between requests. This is important to keep in mind when creating complex APIs with multiple routes. + +Some exceptions to this rule are: + +- [**Global variables**](docs:variables/global-variables) that can be used to store and share data between routes in the templating engine. +- [**Rules based on the request number**](docs:route-responses/dynamic-rules#1-target) that can be used to answer differently based on the index of the requests. +- [**Data buckets**](docs:data-buckets/overview) that can be used to serve data from a shared source. However, the data bucket cannot be modified by an HTTP route, see below. + +## Relation with data buckets + +HTTP routes can use [**data buckets**](docs:data-buckets/overview) to serve data from a **shared source** and avoid duplication. By selecting ["Data bucket" in the route response body type](docs:response-configuration/response-body#data-bucket), you can choose a data bucket to serve data from for any of your routes. + +However, the **data bucket cannot be modified** by an HTTP route. Example: an HTTP route with a PUT method won't be able to update a data bucket. It ensures that the data bucket remains a shared source of truth and that the HTTP routes remain stateless. + +If you want a data bucket to act as a **simple JSON database** and be **manipulated** by your endpoints, you can create [**CRUD routes**](docs:api-endpoints/crud-routes) that will be able to interact with the data bucket by creating, reading, filtering, updating, and deleting data, in a RESTful way. diff --git a/public/images/docs/latest/api-endpoints/folders/routes-nested-folder.png b/public/images/docs/latest/api-endpoints/folders/routes-nested-folder.png index 8170c331..fff9ade8 100644 Binary files a/public/images/docs/latest/api-endpoints/folders/routes-nested-folder.png and b/public/images/docs/latest/api-endpoints/folders/routes-nested-folder.png differ diff --git a/public/images/docs/latest/api-endpoints/http-routes/add-http-route.png b/public/images/docs/latest/api-endpoints/http-routes/add-http-route.png new file mode 100644 index 00000000..a8774ae1 Binary files /dev/null and b/public/images/docs/latest/api-endpoints/http-routes/add-http-route.png differ diff --git a/public/images/docs/latest/api-endpoints/http-routes/new-http-route.png b/public/images/docs/latest/api-endpoints/http-routes/new-http-route.png new file mode 100644 index 00000000..e104c3c4 Binary files /dev/null and b/public/images/docs/latest/api-endpoints/http-routes/new-http-route.png differ diff --git a/public/images/docs/latest/callbacks/overview/add-callback.png b/public/images/docs/latest/callbacks/overview/add-callback.png index 19b6982d..13ed3cf0 100644 Binary files a/public/images/docs/latest/callbacks/overview/add-callback.png and b/public/images/docs/latest/callbacks/overview/add-callback.png differ diff --git a/public/images/docs/latest/data-buckets/overview/add-data-bucket.png b/public/images/docs/latest/data-buckets/overview/add-data-bucket.png index d4a2b655..3d96cdb5 100644 Binary files a/public/images/docs/latest/data-buckets/overview/add-data-bucket.png and b/public/images/docs/latest/data-buckets/overview/add-data-bucket.png differ diff --git a/public/images/docs/latest/logging-and-recording/auto-mocking-and-recording/logs-recording-in-progress.png b/public/images/docs/latest/logging-and-recording/auto-mocking-and-recording/logs-recording-in-progress.png index b34bd518..6d8198bb 100644 Binary files a/public/images/docs/latest/logging-and-recording/auto-mocking-and-recording/logs-recording-in-progress.png and b/public/images/docs/latest/logging-and-recording/auto-mocking-and-recording/logs-recording-in-progress.png differ diff --git a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-button.png b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-button.png index 74eb3beb..692575c9 100644 Binary files a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-button.png and b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-button.png differ diff --git a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-button.png b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-button.png index 8ee3edae..6ecad963 100644 Binary files a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-button.png and b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-button.png differ diff --git a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-create-button.png b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-create-button.png index 69a3ba86..8328cb23 100644 Binary files a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-create-button.png and b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-create-button.png differ diff --git a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-tab.png b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-tab.png index ac6c9ea1..960db0ca 100644 Binary files a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-tab.png and b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-endpoint-tab.png differ diff --git a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-template-tab.png b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-template-tab.png index 6c40bae0..43ff2311 100644 Binary files a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-template-tab.png and b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-generate-template-tab.png differ diff --git a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-template-generate-option.png b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-template-generate-option.png index 2170c509..be3ab312 100644 Binary files a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-template-generate-option.png and b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/ai-assistant-template-generate-option.png differ diff --git a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/templates-generate-get-route.png b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/templates-generate-get-route.png index 1384bc4d..e17e521a 100644 Binary files a/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/templates-generate-get-route.png and b/public/images/docs/latest/mockoon-cloud/templates-and-ai-assistant/templates-generate-get-route.png differ diff --git a/public/images/docs/latest/mockoon-data-files/data-storage-location/environment-move-to-folder.png b/public/images/docs/latest/mockoon-data-files/data-storage-location/environment-move-to-folder.png index 1bbf4e21..9830c04d 100644 Binary files a/public/images/docs/latest/mockoon-data-files/data-storage-location/environment-move-to-folder.png and b/public/images/docs/latest/mockoon-data-files/data-storage-location/environment-move-to-folder.png differ diff --git a/public/images/docs/latest/mockoon-data-files/data-storage-location/environment-show-in-folder.png b/public/images/docs/latest/mockoon-data-files/data-storage-location/environment-show-in-folder.png index 280a108c..c3d483cc 100644 Binary files a/public/images/docs/latest/mockoon-data-files/data-storage-location/environment-show-in-folder.png and b/public/images/docs/latest/mockoon-data-files/data-storage-location/environment-show-in-folder.png differ diff --git a/public/images/docs/latest/mockoon-data-files/environment-clipboard-copy/export-clipboard-env.png b/public/images/docs/latest/mockoon-data-files/environment-clipboard-copy/export-clipboard-env.png index 74685030..ffc8ce60 100644 Binary files a/public/images/docs/latest/mockoon-data-files/environment-clipboard-copy/export-clipboard-env.png and b/public/images/docs/latest/mockoon-data-files/environment-clipboard-copy/export-clipboard-env.png differ diff --git a/public/images/docs/latest/mockoon-data-files/sharing-mock-api-files/open-environment.png b/public/images/docs/latest/mockoon-data-files/sharing-mock-api-files/open-environment.png index 0bd3c4f8..5e1d66df 100644 Binary files a/public/images/docs/latest/mockoon-data-files/sharing-mock-api-files/open-environment.png and b/public/images/docs/latest/mockoon-data-files/sharing-mock-api-files/open-environment.png differ diff --git a/public/images/docs/latest/response-configuration/file-serving/environment-show-in-folder.png b/public/images/docs/latest/response-configuration/file-serving/environment-show-in-folder.png index d917bd9b..bfe03bdb 100644 Binary files a/public/images/docs/latest/response-configuration/file-serving/environment-show-in-folder.png and b/public/images/docs/latest/response-configuration/file-serving/environment-show-in-folder.png differ diff --git a/public/images/docs/latest/response-configuration/response-body/body-data-bucket.png b/public/images/docs/latest/response-configuration/response-body/body-data-bucket.png index f04e985b..6a084745 100644 Binary files a/public/images/docs/latest/response-configuration/response-body/body-data-bucket.png and b/public/images/docs/latest/response-configuration/response-body/body-data-bucket.png differ diff --git a/public/images/docs/latest/response-configuration/response-body/body-file-serving.png b/public/images/docs/latest/response-configuration/response-body/body-file-serving.png index 2b7517ed..b2ca8887 100644 Binary files a/public/images/docs/latest/response-configuration/response-body/body-file-serving.png and b/public/images/docs/latest/response-configuration/response-body/body-file-serving.png differ diff --git a/public/images/docs/latest/response-configuration/response-body/body-type-toggle.png b/public/images/docs/latest/response-configuration/response-body/body-type-toggle.png index e799ff1c..945f87b9 100644 Binary files a/public/images/docs/latest/response-configuration/response-body/body-type-toggle.png and b/public/images/docs/latest/response-configuration/response-body/body-type-toggle.png differ diff --git a/public/images/docs/latest/response-configuration/response-body/inline-body-editor.png b/public/images/docs/latest/response-configuration/response-body/inline-body-editor.png index 783d4ea8..99aca188 100644 Binary files a/public/images/docs/latest/response-configuration/response-body/inline-body-editor.png and b/public/images/docs/latest/response-configuration/response-body/inline-body-editor.png differ diff --git a/public/images/docs/latest/route-responses/dynamic-rules/route-response-rules-operator.png b/public/images/docs/latest/route-responses/dynamic-rules/route-response-rules-operator.png index 3446e867..77561c90 100644 Binary files a/public/images/docs/latest/route-responses/dynamic-rules/route-response-rules-operator.png and b/public/images/docs/latest/route-responses/dynamic-rules/route-response-rules-operator.png differ diff --git a/public/images/docs/latest/server-configuration/cors/enable-cors.png b/public/images/docs/latest/server-configuration/cors/enable-cors.png index fbc1ff1a..8a1d9b01 100644 Binary files a/public/images/docs/latest/server-configuration/cors/enable-cors.png and b/public/images/docs/latest/server-configuration/cors/enable-cors.png differ diff --git a/public/images/docs/latest/server-configuration/serving-over-tls/enable-tls-custom-certificate.png b/public/images/docs/latest/server-configuration/serving-over-tls/enable-tls-custom-certificate.png index 15f5ce80..6a7bdbf6 100644 Binary files a/public/images/docs/latest/server-configuration/serving-over-tls/enable-tls-custom-certificate.png and b/public/images/docs/latest/server-configuration/serving-over-tls/enable-tls-custom-certificate.png differ