Merge pull request #845 from marle3003/develop

Develop

Author: marle3003

.asyncapi-tool.json

@@ -3,7 +3,7 @@
   "description": "Your API Mocking Tool for Agile Development. Mock and simulate AsyncAPI and OpenAPI services for local testing, development, and CI pipelines — with a visual dashboard to inspect your mocks and a powerful test data generator fully customizable with JavaScript.",
   "links": {
     "websiteUrl": "https://mokapi.io",
-    "docsUrl": "https://mokapi.io/docs/guides/welcome",
+    "docsUrl": "https://mokapi.io/docs/welcome",
     "repoUrl": "https://github.com/marle3003/mokapi"
   },
   "filters": {

.github/actions/build-cli-flags-doc/action.yaml

@@ -2,17 +2,11 @@ name: "Build Mokapi CLI Flags doc"
 runs:
   using: composite
   steps:
-    - name: Create directory and file
+    - name: Create dist directory and file
       shell: bash
       run: |
         mkdir -p webui/dist
         touch webui/dist/.tmp
     - name: Build CLI doc
       shell: bash
-      run: go run ./cmd/internal/gen-cli-docs/main.go
-    - name: Add CLI Flags nav entry
-      working-directory: ./docs
-      shell: bash
-      run: |
-        jq '.Configuration.items.Static.items["CLI Flags"] = "configuration/static/mokapi.md"' ./config.json > ./tmp.json
-        mv ./tmp.json ./config.json
+      run: go run ./cmd/internal/gen-cli-docs/main.go

.github/actions/build-release-notes/action.yml

@@ -9,7 +9,7 @@ runs:
         VERSION=$(jq -r '.release.tag_name' "$GITHUB_EVENT_PATH")
         BODY=$(jq -r '.release.body' "$GITHUB_EVENT_PATH")
         {
-          echo "# Mokapi $VERSION"
+          echo "## Mokapi $VERSION"
           echo
           echo "$BODY"
         } > docs/release.md

.github/actions/publish-website/action.yml

@@ -51,25 +51,12 @@ runs:
       if: always()
       run: docker stop mokapi || true
       shell: bash
-    - name: build webui
+    - uses: ./.github/actions/build-cli-flags-doc
+    - name: build website
       working-directory: ./webui
       run: |
         npm install
         npm version ${{ steps.release.outputs.release }}
-        npm run build
-      shell: bash
-    - name: Build CLI doc
-      run: go run ./cmd/internal/gen-cli-docs/main.go
-      shell: bash
-    - name: Add CLI Flags nav entry
-      run: |
-         jq '.Configuration.items.Static.items["CLI Flags"] = "configuration/static/mokapi.md"' ./config.json > ./tmp.json
-         mv ./tmp.json ./config.json
-      working-directory: ./docs
-      shell: bash
-    - name: build website
-      working-directory: ./webui
-      run: |
         npm run copy-docs
         npm run build-sitemap
         npm run build-website

.github/workflows/release.yml

@@ -17,7 +17,6 @@ jobs:
       - uses: actions/setup-go@v5
         with:
           go-version: 1.25.5
-      - uses: ./.github/actions/build-cli-flags-doc
       - uses: ./.github/actions/build-release-notes
       - uses: actions/setup-node@v4
         with:

README.md

@@ -14,7 +14,7 @@
 </p>
 <p align="center">
     <a href="https://github.com/marle3003/mokapi/releases">Download</a> ·
-    <a href="https://mokapi.io/docs/guides/welcome">Documentation</a>
+    <a href="https://mokapi.io/docs/welcome">Documentation</a>
 </p>
 
 # 🚀 Overview
@@ -99,32 +99,32 @@ Mokapi’s dashboard lets you visualize your mock APIs. View requests and respon
 
 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)\
+- 🌍 [Get started with REST API](https://mokapi.io/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 Kafka with AsyncAPI](https://mokapi.io/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)\
+- 👨‍💻 [Mocking LDAP Authentication](https://mokapi.io/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)\
+- 📧 [Mocking SMTP Mail Servers](https://mokapi.io/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)\
+- 🖥️ [End-to-End Testing with Jest and GitHub Actions](https://mokapi.io/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)
+> More examples are available on [mokapi.io/resources](https://mokapi.io/resources)
 
 # 📚 Documentation
 
-- [Get Started](https://mokapi.io/docs/guides/welcome)
-- [HTTP](https://mokapi.io/docs/guides/http)
-- [Kafka](https://mokapi.io/docs/guides/kafka)
-- [LDAP](https://mokapi.io/docs/guides/ldap)
-- [SMTP](https://mokapi.io/docs/guides/mail)
-- [Javascript API](https://mokapi.io/docs/javascript-api)
-- [Resources](https://mokapi.io/docs/resources)
+- [Get Started](https://mokapi.io/docs/welcome)
+- [HTTP](https://mokapi.io/docs/http/overview)
+- [Kafka](https://mokapi.io/docs/kafka/overview)
+- [LDAP](https://mokapi.io/docs/ldap/overview)
+- [SMTP](https://mokapi.io/docs/mail/overview)
+- [Javascript API](https://mokapi.io/docs/javascript-api/overview)
+- [Resources](https://mokapi.io/resources)
 
 # ☕ Support
 

Taskfile.yml

@@ -28,10 +28,12 @@ tasks:
       GOOS: darwin
       GOARCH: arm64
   build-vue-app:
+    deps: [ensure-dist-folder]
     dir: webui
     cmds:
       - npm run clean
       - npm run copy-docs
+      - go run ../cmd/internal/gen-cli-docs/main.go --output-dir ./webui/src/assets/docs/configuration/static
       - npm version {{.VERSION}}
       - npm run build-dashboard
   build-npm-package:
@@ -64,5 +66,9 @@ tasks:
     env:
       GOOS: darwin
       GOARCH: arm64
+  ensure-dist-folder:
+    cmds:
+      - mkdir -p webui/dist
+      - touch webui/dist/.tmp
 
 

acceptance/ldap_test.go

@@ -20,7 +20,7 @@ type LdapSuite struct {
 func (suite *LdapSuite) SetupSuite() {
 	cfg := static.NewConfig()
 	cfg.Api.Port = try.GetFreePort()
-	cfg.Providers.File.Directories = []string{"./ldap"}
+	cfg.Providers.File.Directories = []static.FileConfig{{Path: "./ldap"}}
 	suite.initCmd(cfg)
 	// ensure scripts are executed
 	time.Sleep(2 * time.Second)

acceptance/mail_test.go

@@ -27,7 +27,7 @@ func (suite *MailSuite) SetupSuite() {
 	wd, err := os.Getwd()
 	require.NoError(suite.T(), err)
 	cfg.ConfigFile = path.Join(wd, "mokapi.yaml")
-	cfg.Providers.File.Directories = []string{"./mail"}
+	cfg.Providers.File.Directories = []static.FileConfig{{Path: "./mail"}}
 	cfg.Certificates.Static = []static.Certificate{
 		{Cert: "./mail/mail.mokapi.local.pem"},
 	}

acceptance/petstore_test.go

@@ -24,7 +24,7 @@ type PetStoreSuite struct{ BaseSuite }
 func (suite *PetStoreSuite) SetupSuite() {
 	cfg := static.NewConfig()
 	cfg.Api.Port = try.GetFreePort()
-	cfg.Providers.File.Directories = []string{"./petstore"}
+	cfg.Providers.File.Directories = []static.FileConfig{{Path: "./petstore"}}
 	cfg.Api.Search.Enabled = true
 	suite.initCmd(cfg)
 }