-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathdiscovery.ts
More file actions
253 lines (226 loc) · 6.08 KB
/
discovery.ts
File metadata and controls
253 lines (226 loc) · 6.08 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/**
* API Discovery Service
*
* Provides dynamic API documentation and metadata
*/
import { Router, RouteMetadata } from './router';
import { EndpointRegistry } from './endpoint-registry';
/**
* System capabilities
*/
export interface SystemCapabilities {
/** GraphQL endpoint available */
graphql?: boolean;
/** WebSocket support */
websocket?: boolean;
/** File upload support */
fileUpload?: boolean;
/** Batch operations support */
batch?: boolean;
/** Real-time subscriptions */
realtime?: boolean;
}
/**
* API version info
*/
export interface ApiVersionInfo {
version: string;
releaseDate?: string;
deprecated?: boolean;
sunsetDate?: string;
}
/**
* Discovery response
*/
export interface DiscoveryResponse {
/** API name */
name: string;
/** API version */
version: ApiVersionInfo;
/** API description */
description?: string;
/** Base URL */
baseUrl?: string;
/** System capabilities */
capabilities: SystemCapabilities;
/** Available routes */
routes: RouteMetadata[];
/** API endpoints (from endpoint registry) */
endpoints?: any[];
/** Environment info */
environment?: {
name: string;
region?: string;
[key: string]: any;
};
/** Contact info */
contact?: {
name?: string;
email?: string;
url?: string;
};
/** Links to documentation */
links?: {
documentation?: string;
openapi?: string;
support?: string;
};
}
/**
* Discovery configuration
*/
export interface DiscoveryConfig {
name: string;
version: string;
description?: string;
baseUrl?: string;
capabilities?: SystemCapabilities;
environment?: {
name: string;
region?: string;
[key: string]: any;
};
contact?: {
name?: string;
email?: string;
url?: string;
};
}
/**
* API Discovery Service
*/
export class DiscoveryService {
private router: Router;
private endpointRegistry?: EndpointRegistry;
private config: DiscoveryConfig;
constructor(
router: Router,
config: DiscoveryConfig,
endpointRegistry?: EndpointRegistry
) {
this.router = router;
this.config = config;
this.endpointRegistry = endpointRegistry;
}
/**
* Get discovery information
*/
getDiscovery(): DiscoveryResponse {
const routes = this.router.getRoutes();
const endpoints = this.endpointRegistry?.listEndpoints();
const discovery: DiscoveryResponse = {
name: this.config.name,
version: {
version: this.config.version,
},
description: this.config.description,
baseUrl: this.config.baseUrl,
capabilities: this.config.capabilities || {},
routes: this.filterSystemRoutes(routes),
environment: this.config.environment,
contact: this.config.contact,
links: {
documentation: `${this.config.baseUrl || ''}/docs`,
openapi: `${this.config.baseUrl || ''}/api/openapi`,
},
};
if (endpoints) {
discovery.endpoints = endpoints;
}
return discovery;
}
/**
* Get routes by category
*/
getRoutesByCategory(category: string): RouteMetadata[] {
return this.router.getRoutesByCategory(category as any);
}
/**
* Get routes by tag
*/
getRoutesByTag(tag: string): RouteMetadata[] {
return this.router.getRoutesByTag(tag);
}
/**
* Get route statistics
*/
getRouteStats(): any {
const routes = this.router.getRoutes();
const stats = {
total: routes.length,
byMethod: {} as Record<string, number>,
byCategory: {} as Record<string, number>,
withRateLimit: 0,
deprecated: 0,
};
for (const route of routes) {
// Count by method
stats.byMethod[route.method] = (stats.byMethod[route.method] || 0) + 1;
// Count by category
stats.byCategory[route.category] = (stats.byCategory[route.category] || 0) + 1;
// Count rate limited routes
if (route.rateLimit) {
stats.withRateLimit++;
}
// Count deprecated routes
if (route.deprecated) {
stats.deprecated++;
}
}
return stats;
}
/**
* Filter out system routes from discovery
*/
private filterSystemRoutes(routes: RouteMetadata[]): RouteMetadata[] {
// Include all routes but optionally filter some internal ones
// For now, keep all routes including system ones
return routes;
}
/**
* Update configuration
*/
updateConfig(updates: Partial<DiscoveryConfig>): void {
this.config = { ...this.config, ...updates };
}
}
/**
* Create discovery service
*/
export function createDiscoveryService(
router: Router,
config: DiscoveryConfig,
endpointRegistry?: EndpointRegistry
): DiscoveryService {
return new DiscoveryService(router, config, endpointRegistry);
}
/**
* Register discovery endpoint on router
*/
export function registerDiscoveryEndpoint(
router: Router,
discovery: DiscoveryService
): void {
router.get('/api/discovery', async (req: any, res: any) => {
const discoveryInfo = discovery.getDiscovery();
if (res.json) {
res.json(discoveryInfo);
}
}, {
category: 'system',
summary: 'API Discovery',
description: 'Get information about available API endpoints',
tags: ['system', 'discovery'],
});
router.get('/api/discovery/stats', async (req: any, res: any) => {
const stats = discovery.getRouteStats();
if (res.json) {
res.json(stats);
}
}, {
category: 'system',
summary: 'API Statistics',
description: 'Get statistics about API routes',
tags: ['system', 'discovery'],
});
}