fix: update example configuration and documentation

- Fix file paths in example/api.json to work from root directory
- Update example README with clearer instructions
- Add run.sh script for easier example execution

Author: takeshi iijima

example/README.md

@@ -67,6 +67,18 @@ curl http://localhost:3000/static/index.html
 # Or open in browser: http://localhost:3000/static/index.html
 ```
 
+## Note on File Paths
+
+The paths in the `api.json` configuration file are relative to the directory from which you run the server, not the location of the configuration file itself. This means that when running from the project root, all paths include the `example/` prefix, like:
+
+```json
+{
+  "jsonPath": "./example/health-check.json"
+}
+```
+
+If you want to run the server while in the example directory, you would need to modify the paths in `api.json` to remove the `example/` prefix.
+
 ## Customizing
 
 Feel free to modify these example files or create your own to experiment with the Go JSON Server's capabilities.

example/api.json

@@ -7,47 +7,47 @@
       "method": "GET",
       "status": 200,
       "path": "/",
-      "jsonPath": "./health-check.json"
+      "jsonPath": "./example/health-check.json"
     },
     {
       "method": "GET",
       "status": 200,
       "path": "/users",
-      "jsonPath": "./users.json"
+      "jsonPath": "./example/users.json"
     },
     {
       "method": "GET",
       "status": 200,
       "path": "/user/:id",
-      "jsonPath": "./user-detail.json"
+      "jsonPath": "./example/user-detail.json"
     },
     {
       "method": "GET",
       "status": 200,
       "path": "/posts",
-      "jsonPath": "./posts.json"
+      "jsonPath": "./example/posts.json"
     },
     {
       "method": "GET",
       "status": 200,
       "path": "/posts/:id",
-      "jsonPath": "./post-detail.json"
+      "jsonPath": "./example/post-detail.json"
     },
     {
       "method": "GET",
       "status": 200,
       "path": "/users/:userId/posts/:postId",
-      "jsonPath": "./user-post.json"
+      "jsonPath": "./example/user-post.json"
     },
     {
       "method": "POST",
       "status": 201,
       "path": "/users",
-      "jsonPath": "./user-created.json"
+      "jsonPath": "./example/user-created.json"
     },
     {
       "path": "/static",
-      "folder": "./static"
+      "folder": "./example/static"
     }
   ]
 }

example/run.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Change to the root directory of the project
+cd $(dirname $0)/..
+
+# Run the server with the example configuration
+go run go-json-server.go --config=./example/api.json