Merge pull request #530 from marle3003/develop

Develop

Author: marle3003

.goreleaser.windows.yml

@@ -38,17 +38,24 @@ chocolateys:
     tags: "cross-platform testing devops api mock http kafka rest smtp ldap contract openapi asyncapi"
     summary: Your API Mocking Tool for Agile Development using Go and Javascript
     description: |
-      **Mokapi** is an open-source tool that allows Agile, DevOps and Continuous Deployment teams
-      to create and test API designs before actually building them.
+      <p align="center">
+      <a href="https://mokapi.io">
+      <img src="https://raw.githubusercontent.com/marle3003/mokapi/refs/heads/main/logo.svg" alt="Mokapi" title="Mokapi" width="300" />
+      </a>
+      </p>
       
-      With Mokapi you can quickly and easily test various
-      scenarios, such as delayed or failed responses without
-      having to rely on a fully functional API.
+      <h3 align="center">Your API Mocking Tool for Agile Development</h3>
       
-      Mokapi helps you improve the quality of APIs and
-      reduces the risk of bugs or errors in production.
+      # 🚀 Overview
       
-      Its core feature are:
+      Mokapi is an open-source tool that helps Agile, DevOps, and Continuous
+      Deployment teams design, test, and validate APIs before implementation.
+      It enables rapid prototyping of scenarios—like delayed responses,
+      failures, or edge cases—without needing a live backend. By simulating
+      real-world conditions early, Mokapi improves API quality and reduces
+      the risk of bugs in production.
+    
+      # ✨ Features
       
       - **Multiple Protocol support**: HTTP, HTTPS, Apache Kafka, SMTP, LDAP
       - **Everything as Code**: Reusing, version control, consistency and integrate mocks with your CI/CD.
@@ -57,10 +64,106 @@ chocolateys:
       - **Multiple Provider support**: File, HTTP, GIT, NPM to gather configurations and scripts.
       - **Dashboard** to see what's going on.
       
-      **Usage:***
+      ## 🔧 Spin Up Mokapi
+        
+      Install and start Mokapi using one of the following methods.
+      Replace the URL with your own OpenAPI or AsyncAPI specification.
+      
+      Windows
+      ```shell
+      choco install mokapi
+      mokapi https://petstore31.swagger.io/api/v31/openapi.json
       ```
+      
+      MacOS
+      ```shell
+      brew tap marle3003/tap
+      brew install mokapi
       mokapi https://petstore31.swagger.io/api/v31/openapi.json
       ```
+      
+      Docker
+      ```shell
+      docker run -p 80:80 -p 8080:8080 mokapi/mokapi:latest https://petstore31.swagger.io/api/v31/openapi.json
+      ```
+      
+      # 🎯 Hit Your First Mock
+      Once Mokapi is running, you can make requests to your mocked API like so:
+      ```shell
+      curl http://localhost/api/v31/pet/2 -H 'Accept: application/json'
+      ```
+        
+      # 🧩 Customize Your Mock with JavaScript
+      
+      Mokapi makes it simple to control responses using embedded JavaScript.
+      
+      For example, you can dynamically change the response based on query parameters:
+        
+      ```typescript
+      import { on } from 'mokapi';
+        
+      export default function() {
+        on('http', (request, response): boolean => {
+          switch (request.path.petId) {
+            case 2:
+              response.data.name = 'Betty';
+                return true;
+            case 9:
+              response.statusCode = 404;
+          }
+          return false;
+        });
+      }
+      ```
+        
+      # 🖥️ Dashboard
+        
+      Mokapi’s dashboard lets you visualize your mock APIs. View requests and responses in real-time, generate and validate sample data for testing.
+        
+      <img src="https://raw.githubusercontent.com/marle3003/mokapi/refs/heads/main/webui.png" alt="Mokapi Web UI" title="Mokapi Web UI" />
+      
+      # 🧪 Learn by Example
+      
+      Explore tutorials that walk you through mocking different protocols and scenarios:
+      
+      - 🌍 [Get started with REST API](https://mokapi.io/docs/resources/tutorials/get-started-with-rest-api)\
+        This tutorial will show you how to mock a REST API using an OpenAPI specification.
+      
+      - ⚡ [Mocking Kafka with AsyncAPI](https://mokapi.io/docs/resources/tutorials/get-started-with-kafka)\
+        Mocking a Kafka topic using Mokapi and verifying that a producer generates valid messages.
+      
+      - 👨‍💻 [Mocking LDAP Authentication](https://mokapi.io/docs/resources/tutorials/mock-ldap-authentication-in-node)\
+        Simulate LDAP-based login flows, including group-based permissions.
+      
+      - 📧 [Mocking SMTP Mail Servers](https://mokapi.io/docs/resources/tutorials/mock-smtp-server-send-mail-using-node)\
+        Use Mokapi to simulate sending and receiving emails in Node.js apps.
+      
+      - 🖥️ [End-to-End Testing with Jest and GitHub Actions](https://mokapi.io/docs/resources/tutorials/running-mokapi-in-a-ci-cd-pipeline)\
+        Integrate Mokapi into your CI pipeline for full-stack E2E testing.
+        
+      > More examples are available on [mokapi.io/docs/resources](https://mokapi.io/docs/resources)
+      
+      # 📚 Documentation
+      
+      - [Get Started](https://mokapi.io/docs/guides/welcome)
+      - [HTTP](https://mokapi.io/docs/guides/http)
+      - [Kafka](https://mokapi.io/docs/guides/kafka/overview)
+      - [LDAP](https://mokapi.io/docs/guides/ldap/overview)
+      - [SMTP](https://mokapi.io/docs/guides/smtp/overview)
+      - [Javascript API](https://mokapi.io/docs/javascript-api)
+      - [Examples & Tutorials](https://mokapi.io/docs/resources)
+      - [Blogs](https://mokapi.io/docs/blogs)
+      
+      # ☕ Support
+      
+      If you find Mokapi helpful, consider supporting the project:
+      
+      <a href="https://www.buymeacoffee.com/mokapi" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
+      
+      # 📄 License
+      
+      This project is licensed under the MIT License. See the [LICENSE](https://github.com/marle3003/mokapi/blob/main/LICENSE) file for details.
+      ```
     release_notes: "https://github.com/marle3003/mokapi/releases/tag/v{{ .Version }}"
 
     url_template: "https://github.com/marle3003/mokapi/releases/download/{{ .Tag }}/{{ .ArtifactName }}"

README.md

@@ -97,20 +97,20 @@ Mokapi’s dashboard lets you visualize your mock APIs. View requests and respon
 
 Explore tutorials that walk you through mocking different protocols and scenarios:
 
-- 🔐 [Mocking Authentication with OpenAPI](https://mokapi.io/docs/resources/tutorials/mock-openapi-authentication-api-key-&-bearer-token)\
-Use API key and Bearer token authentication in a mocked API.
+- 🌍 [Get started with REST API](https://mokapi.io/docs/resources/tutorials/get-started-with-rest-api)\
+  This tutorial will show you how to mock a REST API using an OpenAPI specification.
 
 - ⚡ [Mocking Kafka with AsyncAPI](https://mokapi.io/docs/resources/tutorials/get-started-with-kafka)\
-  mocking a Kafka topic using Mokapi and verifying that a producer generates valid messages.
+  Mocking a Kafka topic using Mokapi and verifying that a producer generates valid messages.
 
 - 👨‍💻 [Mocking LDAP Authentication](https://mokapi.io/docs/resources/tutorials/mock-ldap-authentication-in-node)\
-Simulate LDAP-based login flows, including group-based permissions.
+  Simulate LDAP-based login flows, including group-based permissions.
 
 - 📧 [Mocking SMTP Mail Servers](https://mokapi.io/docs/resources/tutorials/mock-smtp-server-send-mail-using-node)\
-Use Mokapi to simulate sending and receiving emails in Node.js apps.
+  Use Mokapi to simulate sending and receiving emails in Node.js apps.
 
 - 🖥️ [End-to-End Testing with Jest and GitHub Actions](https://mokapi.io/docs/resources/tutorials/running-mokapi-in-a-ci-cd-pipeline)\
-Integrate Mokapi into your CI pipeline for full-stack E2E testing.
+  Integrate Mokapi into your CI pipeline for full-stack E2E testing.
 
 > More examples are available on [mokapi.io/docs/resources](https://mokapi.io/docs/resources)
 

npm/README.md

@@ -1,6 +1,6 @@
 <p align="center">
 <a href="https://mokapi.io">
-<img src="logo.svg" alt="Mokapi" title="Mokapi" width="300" />
+<img src="https://raw.githubusercontent.com/marle3003/mokapi/refs/heads/main/logo.svg" alt="Mokapi" title="Mokapi" width="300" />
 </a>
 </p>
 
@@ -80,14 +80,14 @@ export default function() {
 
 Mokapi’s dashboard lets you visualize your mock APIs. View requests and responses in real-time, generate and validate sample data for testing.
 
-<img src="webui.png" alt="Mokapi Web UI" title="Mokapi Web UI" />
+<img src="https://raw.githubusercontent.com/marle3003/mokapi/refs/heads/main/webui.png" alt="Mokapi Web UI" title="Mokapi Web UI" />
 
 # 🧪 Learn by Example
 
 Explore tutorials that walk you through mocking different protocols and scenarios:
 
-- 🔐 [Mocking Authentication with OpenAPI](https://mokapi.io/docs/resources/tutorials/mock-openapi-authentication-api-key-&-bearer-token)\
-  Use API key and Bearer token authentication in a mocked API.
+- 🌍 [Get started with REST API](https://mokapi.io/docs/resources/tutorials/get-started-with-rest-api)\
+  This tutorial will show you how to mock a REST API using an OpenAPI specification.
 
 - ⚡ [Mocking Kafka with AsyncAPI](https://mokapi.io/docs/resources/tutorials/get-started-with-kafka)\
   mocking a Kafka topic using Mokapi and verifying that a producer generates valid messages.