{"id":346,"date":"2025-02-09T15:05:48","date_gmt":"2025-02-09T14:05:48","guid":{"rendered":"https:\/\/pythonium.net\/?page_id=346"},"modified":"2025-02-09T12:35:56","modified_gmt":"2025-02-09T10:35:56","slug":"mockapy","status":"publish","type":"page","link":"https:\/\/pythonium.net\/mockapy","title":{"rendered":"Mock API"},"content":{"rendered":"\n<a href=\"https:\/\/github.com\/cyrilbois\/mockapy\" class=\"github-corner\" aria-label=\"View source on GitHub\">\n  <svg width=\"80\" height=\"80\" viewBox=\"0 0 250 250\" style=\"fill:#fff; color:#151513; position: absolute; top: 0; border: 0; right: 0;\" aria-hidden=\"true\">\n    <path d=\"M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z\"><\/path>\n    <path d=\"M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2\" fill=\"currentColor\" style=\"transform-origin: 130px 106px;\" class=\"octo-arm\"><\/path>\n    <path d=\"M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z\" fill=\"currentColor\" class=\"octo-body\"><\/path>\n  <\/svg>\n<\/a>\n<style>\n  .github-corner { position: fixed; top:0px; right:0px; } \n  .github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}\n  @keyframes octocat-wave{\n    0%,100%{transform:rotate(0)}\n    20%,60%{transform:rotate(-25deg)}\n    40%,80%{transform:rotate(10deg)}\n  }\n  @media (max-width:500px){\n    .github-corner:hover .octo-arm{animation:none}\n    .github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}\n  }\n<\/style>\n\n<style>\n.editor-error{color:red;padding:8px;background-color:#f6cece;margin:10px 0}.editor-valid{color:green;padding:8px;background-color:#d0f5a9;margin:10px 0}.editor-inprogress{color:orange;padding:8px;background-color:#ffe680;margin:10px 0}\n\ninput[type=\"button\"].editor-compare {\n    float: right;\n    margin-top: -46px;\n    padding: 11px 14px;\n    font-size: 1.6em;\n    border: 1px solid black;\n}\n.editor-title {font-weight: bold; font-size:19px; align:center; text-align:center;}\n.column-double {width: 47%; margin-left:1%; display: inline-block; }\n.editor-container {border: 1px solid gray;} \n@media (max-width:860px){\n\t.column-double {width: 97%; margin-left:1%;}\n}\n.message-created {\n    border: 1px solid black;\n    padding: 20px;\n    font-size: 19px;\n    font-weight: bold;\n}\n \n.hidden {display: none;}\n.right {\nfloat:right;\n}\ninput[type=\"button\"].editor-generate {\n    margin-top: -40px;\n    margin-left:auto;\n    margin-right:auto;\npadding: 11px 14px;\n    font-size: 1.6em;\n    border: 1px solid black;\n}\n\n<\/style>\n\n\n\n<p class=\"has-text-align-center has-large-font-size\">A free and open-source fake API designed for testing and prototyping, with Python for added flexibility.<\/p>\n\n\n\n<p><strong>Custom API &amp; Rule Engine<\/strong><br>Instantly generate a custom API from a JSON object and customize its behavior with a Python rule engine. Define rules to handle errors, modify HTTP responses, headers, and bodies using Python scripts\u2014all for free and open source. Access the source code to set up your own local instance.<\/p>\n\n\n\n<p><strong>How to Create a Custom API?<\/strong><br><a href=\"https:\/\/github.com\/cyrilbois\/mockapy\" title=\"\">MockAPY, available on GitHub<\/a>, lets you create a local mock API with custom rules. Alternatively, you can generate an API online using the editors below, but without custom rules. The API will be immediately accessible but is deleted once a day. If needed, you can recreate it on this page. For frequent usage, consider setting up a local API to avoid limitations.<\/p>\n\n\n\n<input type=\"file\" class=\"hidden\" id=\"file-input-db\" \/>\n<input type=\"file\" class=\"hidden\" id=\"file-input-rule\" \/>\n<div style=\"vertical-align: top;\">\n    <div >\n        <div class=\"editor-title\">Resources<\/div>\n        <input type=\"button\" class=\"action-button-editor right\" value=\"Browse file\" onClick=\"document.getElementById('file-input-db').click();\" \/>\n        <br\/>\n        <div class=\"editor-container\" style=\"clear:both;\">\n            <textarea id=\"editor-container-db\" class=\"editor\">{\n  \"products\": [\n    {\n      \"id\": \"1\", \"name\": \"T-shirt\", \"price\": 19.99\n    },\n    {\n      \"id\": \"2\", \"name\": \"Jeans\", \"price\": 49.99\n    }\n  ],\n  \"users\": [\n    {\n      \"id\": \"1\", \"username\": \"johndoe\", \"email\": \"johndoe@example.com\"\n    },\n    {\n      \"id\": \"2\", \"username\": \"janedoe\", \"email\": \"janedoe@example.com\"\n    }\n  ]\n}\n<\/textarea>\n        <\/div>\n    <\/div>\n<\/div>    \n\n<br\/>\n<div id=\"old-endpoint-message\" style=\"display:none;text-align:center;\"><br\/>Your endpoint was set to <span id=\"old-endpoint\"><\/span><br\/><br\/><\/div>\n\n<input type=\"button\" class=\"action-button-editor editor-generate\" style=\"clear-both; display: block; margin: 10px auto; margin-top: 10px;\" value=\"Create\/Update my custom API\" id=\"generate\">\n\n<br\/>\n<div id=\"editor-error\" style=\"display:none;\" class=\"editor-error\"><\/div>\n<div id=\"editor-valid\" style=\"display:none;\" class=\"editor-valid\"><\/div>\n<br\/>\n\n<div class=\"message-created\" id=\"message-created\" style=\"display: none;\">\n    <p>\n        Your endpoint API is now available here: <span id=\"url\"><\/span>\n    <\/p>\n    <p>\n        Access to your resources:\n        <span id=\"ressources-url\"><\/span>\n    <\/p>\n    <p>\n        Note: Once a day, the APIs are deleted. You can return to this page to recreate your API.\n    <\/p>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\">Documentation<\/h2>\n\n\n\n<h3 class=\"wp-block-heading\">Routes<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td>GET<\/td><td>\/products<\/td><td>Returns all products<\/td><\/tr><tr><td>GET<\/td><td>\/products\/2<\/td><td>Returns the product with ID 2<\/td><\/tr><tr><td>POST<\/td><td>\/products<\/td><td>Create a new product<\/td><\/tr><tr><td>GET<\/td><td>\/products\/2<\/td><td>Returns the product with ID 2<\/td><\/tr><tr><td>PUT<\/td><td>\/products\/2<\/td><td>Update the product with ID 2<\/td><\/tr><tr><td>PATCH<\/td><td>\/products\/2<\/td><td>Update partially the product with ID 2<\/td><\/tr><tr><td>DELETE<\/td><td>\/products\/2<\/td><td>Delete the product with ID 2<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Configuration of the resources<\/h3>\n\n\n\n<p>All resources must be contained within a single JSON object, where each attribute represents a resource holding an array of elements.<\/p>\n\n\n\n<p>In this example, two resources have been created: <strong>\"products\"<\/strong> and <strong>\"users\"<\/strong>, each containing two elements.<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"products\": &#91;\n    {\n      \"id\": \"1\", \"name\": \"T-shirt\", \"price\": 19.99\n    },\n    {\n      \"id\": \"2\", \"name\": \"Jeans\", \"price\": 49.99\n    }\n  ],\n  \"users\": &#91;\n    {\n      \"id\": \"1\", \"username\": \"johndoe\", \"email\": \"johndoe@example.com\"\n    },\n    {\n      \"id\": \"2\", \"username\": \"janedoe\", \"email\": \"janedoe@example.com\"\n    }\n  ]\n}<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\">Configuration of the rules<\/h2>\n\n\n\n<p>Custom rules are defined using Python code, allowing you to set conditions based on the request (e.g., HTTP method, headers, and payload) and control the response (including HTTP status code and payload). This enables you to customize the API's behavior for specific testing and development needs.<\/p>\n\n\n\n<p>Rules are executed before the API processes data (reading, writing, or deleting).<\/p>\n\n\n\n<p>The HTTP status and payload specified in the rules override those defined by the API.<\/p>\n\n\n\n<p>Here is an example of a rule that returns an HTTP status 401 when accessing the resource <em>\/products\/23<\/em>:<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">import request\nimport response\nimport json\n\ndef handle_request():\n    if request.pathname() == \"\/products\/23\":\n        response.status(401)\n        response.exit()<\/pre>\n\n\n\n<p>The&nbsp;<code>exit<\/code>&nbsp;method indicates whether to halt after applying the rule or to continue with the API execution.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Input<a href=\"https:\/\/github.com\/cyrilbois\/jsoning-api#input\"><\/a><\/h3>\n\n\n\n<p>The&nbsp;<code>input<\/code>&nbsp;object is used to represent the different criteria that can be tested in the request.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Attribute<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>headers<\/td><td>The headers (Object: each header is an attribute)<\/td><\/tr><tr><td>method<\/td><td>The HTTP method (\u2018GET\u2019, \u2018POST\u2019, \u2018PUT\u2019, \u2018PATCH\u2019, \u2018DELETE\u2019)<\/td><\/tr><tr><td>path<\/td><td>The pathname of the URL (e.g., \/users\/23).<\/td><\/tr><tr><td>payload<\/td><td>The payload (object or string)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Output<a href=\"https:\/\/github.com\/cyrilbois\/jsoning-api#output\"><\/a><\/h3>\n\n\n\n<p>The&nbsp;<code>output<\/code>&nbsp;object is used to update the response if the rule match.<\/p>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Attribute<\/th><th>Description<\/th><\/tr><\/thead><tbody><tr><td>status<\/td><td>Sets the HTTP status (e.g., 200, 404, etc.)<\/td><\/tr><tr><td>response<\/td><td>Sets the response payload<\/td><\/tr><tr><td>headers<\/td><td>Sets the headers&nbsp;(Object: each header is an attribute)<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>Why use a mock API when developing with Python?<\/strong><\/h3>\n\n\n\n<p>Using a <strong>Mock API<\/strong> is incredibly useful when developing web applications with Python, especially with <strong>Django, Flask, and FastAPI<\/strong>. It allows developers to <strong>simulate API responses<\/strong>, which is helpful for testing applications even when the actual API is unavailable or still under development. It also makes it much easier to handle <strong>error scenarios<\/strong> such as timeouts, HTTP 500 errors, or invalid responses. Hopefully, this simple yet powerful <strong>Mock REST API<\/strong> tool will be useful to you!<\/p>\n\n\n\n<p><\/p>\n\n\n\n<p><a href=\"https:\/\/github.com\/cyrilbois\/jsoning-api\"><\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>A free and open-source fake API designed for testing and prototyping, with Python for added flexibility. Custom API &amp; Rule EngineInstantly generate a custom API from a JSON object and customize its behavior with a Python rule engine. Define rules to handle errors, modify HTTP responses, headers, and bodies using Python scripts\u2014all for free and [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/pythonium.net\/wp-json\/wp\/v2\/pages\/346"}],"collection":[{"href":"https:\/\/pythonium.net\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/pythonium.net\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/pythonium.net\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/pythonium.net\/wp-json\/wp\/v2\/comments?post=346"}],"version-history":[{"count":21,"href":"https:\/\/pythonium.net\/wp-json\/wp\/v2\/pages\/346\/revisions"}],"predecessor-version":[{"id":348,"href":"https:\/\/pythonium.net\/wp-json\/wp\/v2\/pages\/346\/revisions\/348"}],"wp:attachment":[{"href":"https:\/\/pythonium.net\/wp-json\/wp\/v2\/media?parent=346"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}