Merge pull request #134 from rakutentech/feature/group-release

(v2.3) group by UI

Author: kevincobain2000

README.md

@@ -29,7 +29,7 @@
 - Support for Authorization Headers
 - Display extra documentation using markdown
 - Saves history previous requests
-- Added filters to sort, group and filter routes by methods, controllers, middlewares, routes (also see Roadmap 2.x)
+- Added filters to sort, group and filter routes by methods, controllers, middlewares, routes
 - Export laravel API, routes, rules and documentation to Postman and OpenAPI 3.0.0
 
 # Read on Medium
@@ -156,9 +156,8 @@ Fixing lints
 
 # Roadmap for v2.x
 
-- [DONE] UI renewal
-- [WIP] Introduce groupby controller names, routes, middlewares
-- [WIP] Introduce fetch rules from PHP doc annotations
+- UI renewal
+- Introduce groupby controller names, routes, middlewares
 
 # Changelog
 
@@ -181,5 +180,7 @@ Fixing lints
 - v2.0 UI Renewal to React static
     - `@QAParam` is now `@LRDparam`
     - No special changes for users, upgrade to v2.x as usual
+    - Upgrading users will need to republish config
 - v2.1 UI - adds search bar and few aligment fixes on table
 - v2.2 PHP 8.1 and 8.2 support added
+- v2.3 Groupby enabled for routes and controllers

src/Controllers/LaravelRequestDocsController.php

@@ -60,8 +60,6 @@ public function api(Request $request)
             Response::HTTP_OK,
             [
                 'Content-type'=> 'application/json; charset=utf-8',
-                'Cache-Control' => 'public, max-age=60',
-                'Expires' => gmdate('D, d M Y H:i:s \G\M\T', time() + 60),
             ],
             JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE
         );

ui/src/components/Sidebar.tsx

@@ -16,6 +16,8 @@ interface IAPIInfo {
     httpMethod: string;
     rules: IAPIRule;
     docBlock: string;
+    group: string|null;
+    group_index: number|null;
 }
 
 interface Props {
@@ -33,17 +35,25 @@ export default function Sidebar(props: Props) {
                 </h2>
                 <ul>
                     {lrdDocsJson.map((lrdDocsItem) => (
-                        lrdDocsItem.methods.map((method) => (
-                            <li key={shortid.generate()}>
-                                <AnchorLink href={'#' + method + lrdDocsItem.uri} className="flex flex-row px-0 py-1">
-                                    <span className={`method-${method} uppercase text-xs w-12 p-0 flex flex-row-reverse`}>
-                                        {method}
-                                    </span>
-                                    <span className="flex-1 p-0 text-sm text-left break-all">
-                                        {lrdDocsItem.uri}
-                                    </span>
-                                </AnchorLink>
-                            </li>
+                        lrdDocsItem.methods.map((method, methodIndex) => (
+                            <div key={shortid.generate()}>
+                                {(lrdDocsItem.group != null && lrdDocsItem.group != "" && lrdDocsItem.group_index == 0 && methodIndex == 0) && (
+                                    <li className="pt-5 text-slate-600">
+                                        {/* Only in case of controller names full path -> just controller name */}
+                                        {lrdDocsItem.group.split('\\').pop()}
+                                    </li>
+                                )}
+                                <li>
+                                    <AnchorLink href={'#' + method + lrdDocsItem.uri} className="flex flex-row px-0 py-1">
+                                        <span className={`method-${method} uppercase text-xs w-12 p-0 flex flex-row-reverse`}>
+                                            {method}
+                                        </span>
+                                        <span className="flex-1 p-0 text-sm text-left break-all">
+                                            {lrdDocsItem.uri}
+                                        </span>
+                                    </AnchorLink>
+                                </li>
+                            </div>
                         ))
                     ))}
                     <li className='bg-transparent'></li>

ui/src/components/TopNav.tsx

@@ -130,21 +130,20 @@ export default function TopNav(props: Props) {
                                         <span className="label-text">HTTP Methods</span>
                                     </label>
                                 </div>
-                                {/* Not Implemented */}
-                                {/* <h4 className="font-bold mt-10">Group By</h4>
+                                <h4 className="font-bold mt-10">Group By</h4>
                                 <div className="form-control">
                                     <label className="label">
 
                                         <input type="radio" onChange={handleChangeGroupby} value="default" className="radio" checked={groupby == "default"} />
                                         <span className="label-text">Default</span>
 
-                                        <input type="radio" onChange={handleChangeGroupby} value="controller_names" className="radio" checked={groupby == "controller_names"} />
-                                        <span className="label-text">Controllers</span>
+                                        <input type="radio" onChange={handleChangeGroupby} value="api_uri" className="radio" checked={groupby == "api_uri"} />
+                                        <span className="label-text">API URI</span>
 
-                                        <input type="radio" onChange={handleChangeGroupby} value="middleware_names" className="radio" checked={groupby == "middleware_names"} />
-                                        <span className="label-text">Middlewares</span>
+                                        <input type="radio" onChange={handleChangeGroupby} value="controller_full_path" className="radio" checked={groupby == "controller_full_path"} />
+                                        <span className="label-text">Controller Names</span>
                                     </label>
-                                </div> */}
+                                </div>
                                 <h4 className="font-bold mt-10">Display Settings</h4>
                                 <div className="form-control">
                                     <label className="label">