@@ -38,38 +38,39 @@ codebase-root/
38
38
39
39
#### Explanation of the listed files:
40
40
41
- - ` codebase-root/ ` is the root directory of the codebase. Choose any directory.
41
+ - ` codebase-root/ ` This is the root directory of the codebase. ( Choose any directory) .
42
42
43
- - ` codebase-root/api-funcs-base/ ` is the directory where all the API definitions are stored.
44
- * Directory name does not need to be ` api-funcs-base ` . It can be anything.*
43
+ - ` codebase-root/api-funcs-base/ ` This is the directory where all the API definitions are stored.
44
+ ( Directory name does not need to be ` api-funcs-base ` . It can be anything.)
45
45
46
- - `@all.php` [Optional] is the file that is called for all the functions in this directory *** and its subdirectories* **.
46
+ - `@all.php` [Optional] This file is executed before all the APIs in this directory **and its subdirectories**.
47
47
48
- - `@index.php` [Optional] File that defines the api available at https://api.sample.dev
48
+ - `@index.php` [Optional] This file defines the API available at https://api.sample.dev
49
49
50
- - `Ping.php` is the file that defines the api available at https://api.sample.dev/ping
50
+ - `Ping.php` This file defines the API available at https://api.sample.dev/ping
51
51
52
- - `Example/` is a directory that contains more API functions .
52
+ - `Example/` This directory contains all APIs grouped under 'example' API .
53
53
54
- - `@all.php` [Optional] is the file that is called for all the functions in this directory *** and its subdirectories* **.
54
+ - `@all.php` [Optional] This file is executed before all the APIs in this directory **and its subdirectories**.
55
55
56
- - `@index.php` [Optional] File that defines the api available at https://api.sample.dev/example
56
+ - `@index.php` [Optional] This file defines the API available at https://api.sample.dev/example
57
57
58
- - `Adder.php` is the file that defines the api available at https://api.sample.dev/example.adder
58
+ - `Adder.php` This file defines the API available at https://api.sample.dev/example.adder
59
59
60
- - `CamelCase/` is a directory that contains more API functions .
60
+ - `CamelCase/` This directory contains all APIs grouped under 'example.camel_case' API .
61
61
62
- - `@index.php` [Optional] File that defines the api available at https://api.sample.dev/example.camel_case
62
+ - `@index.php` [Optional] This file defines the API available at https://api.sample.dev/example.camel_case
63
63
64
- - `Hello.php` is the file that defines the api available at https://api.sample.dev/example.camel_case.hello
64
+ - `Hello.php` This file defines the API available at https://api.sample.dev/example.camel_case.hello
65
65
66
66
67
- - ` codebase-root/public/ ` is the public directory where the server is running.
67
+ - ` codebase-root/public/ ` This is the public directory where the server is running.
68
+ (i.e. https://api.sample.dev must point to this directory.)
68
69
* Directory name does not need to be ` public ` . It can be anything.*
69
70
70
- - `.htaccess` is the file that redirects all requests to `index.php` .
71
+ - `.htaccess` This file is used to rewrite the URLs to the API framework .
71
72
72
- - `index.php` is the file that initializes the API framework .
73
+ - `index.php` This file is the entry point of the server .
73
74
74
75
75
76
0 commit comments