Skip to content

Create endpoints view #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jajaramillo24 merged 1 commit into from
Feb 14, 2025
Merged

Create endpoints view #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions app/Http/Controllers/RouteController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Route;

class RouteController extends Controller
{
public function index()
{
$routes = collect(Route::getRoutes())->filter(function ($route) {
return strpos($route->getActionName(), 'App\Http\Controllers') !== false;
})->map(function ($route) {
return [
'url' => $route->uri(),
'name' => $route->getName(),
'action' => $route->getActionName(),
'method' => $route->methods()[0], // Get the first HTTP method for the route
'middleware' => $route->middleware(),
];
});

return view('endpoints', [
'routeData' => $routes,
]);
}
}
131 changes: 131 additions & 0 deletions resources/views/endpoints.blade.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>API Endpoints</title>
<style>
/* General styling for dark theme */
body {
background-color: #121212;
color: #e0e0e0;
font-family: Arial, sans-serif;
margin: 0;
padding: 0;
}
.container {
max-width: 800px;
margin: 0 auto;
padding: 20px;
}

/* Search box styling */
.search-container {
margin-bottom: 20px;
}
.search-input {
width: 100%;
padding: 10px;
font-size: 16px;
background-color: #1e1e1e;
color: #e0e0e0;
border: 1px solid #333;
border-radius: 4px;
}

/* Card styling */
.card {
background-color: #1e1e1e;
border: 1px solid #333;
border-radius: 8px;
padding: 20px;
}
.card-header {
font-size: 22px;
font-weight: bold;
color: #ffffff;
margin-bottom: 15px;
}

/* Endpoint list styling */
.endpoint-list {
list-style-type: none;
padding: 0;
margin: 0;
}
.endpoint-item {
border-bottom: 1px solid #333;
padding: 10px 0;
}
.endpoint-info {
display: flex;
align-items: center;
margin-bottom: 5px;
}

/* Method badge styles */
.endpoint-method {
padding: 6px 10px;
border-radius: 4px;
font-weight: bold;
color: #ffffff;
margin-right: 10px;
text-transform: uppercase;
}
.get { background-color: #4caf50; }
.post { background-color: #2196f3; }
.put { background-color: #ff9800; }
.delete { background-color: #f44336; }


/* URL and description styles */
.endpoint-url {
font-weight: bold;
color: #e0e0e0;
}
.endpoint-description {
color: #b0b0b0;
}
</style>
</head>
<body>
<div class="container">
<div class="search-container">
<input type="text" class="search-input" placeholder="Search endpoints..." />
</div>

<div class="card">
<div class="card-header">API Endpoints</div>
<ul class="endpoint-list">
@foreach ($routeData as $route)
<li class="endpoint-item">
<div class="endpoint-info">
<div class="endpoint-method {{ strtolower($route['method']) }}">{{ $route['method'] }}</div>
<div class="endpoint-url">{{ $route['url'] }}</div>
</div>
<div class="endpoint-description">{{ $route['name'] }} - {{ $route['action'] }}</div>
</li>
@endforeach
</ul>
</div>
</div>

<script>
const searchInput = document.querySelector('.search-input');
const endpointItems = document.querySelectorAll('.endpoint-item');

searchInput.addEventListener('input', () => {
const searchTerm = searchInput.value.toLowerCase();
endpointItems.forEach(item => {
const url = item.querySelector('.endpoint-url').textContent.toLowerCase();
const description = item.querySelector('.endpoint-description').textContent.toLowerCase();
if (url.includes(searchTerm) || description.includes(searchTerm)) {
item.style.display = 'block';
} else {
item.style.display = 'none';
}
});
});
</script>
</body>
</html>
3 changes: 3 additions & 0 deletions routes/web.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,6 @@
Route::get('/', function () {
return redirect()->to('https://whatnow.preparecenter.org');
});
// API documentation
Route::get('/endpoints', [\App\Http\Controllers\RouteController::class, 'index'])
->name('endpoints.index'); // Displays list of available API endpoints with documentation
Loading