Azure / Azure/data-api-builder

[Enh]: Improve health endpoint with filters

Offen
#3,278 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
2.x health-endpoint
Vorherrschende Sprache
C#
Sterne
1.5k
Forks
370
Ø Merge
3 T. 22 Std.
Gemergte PRs (30 T.)
9

Beschreibung

## What

Make the health endpoint easier to use.

### Introduce tag filters

Support filtering health checks by tag using query parameters.

```
https://localhost:5000/health?tag=rest
https://localhost:5000/health?tag=graphql
https://localhost:5000/health?tag=mcp
https://localhost:5000/health?tag=endpoint
https://localhost:5000/health?tag=data-source
```

Support compound filters by specifying multiple tags.

```
https://localhost:5000/health?tag=rest&tag=graphql
```

### Introduce easy aliases

Provide simple aliases for common filters so they are easy to demo and remember.

```
https://localhost:5000/health/rest
https://localhost:5000/health/graphql
https://localhost:5000/health/mcp
https://localhost:5000/health/data-source
```

These routes internally translate to the equivalent tag filter.

```
/health/rest -> /health?tag=rest
/health/graphql -> /health?tag=graphql
/health/mcp -> /health?tag=mcp
/health/data-source -> /health?tag=data-source
```

### Introduce UI

Introduce a path that consumes the health report and renders it as a web page.

```
https://localhost:5000/health/ui
```

A similar feature is already present in our extension: https://marketplace.visualstudio.com/items?itemName=jerry-nixon.health-data-api-builder

> [!NOTE]
> This feature will shine. A valuable part of our Aspire story. An important link to emit with `dab start`.

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne am Einstiegspunkt des Health-Endpunkts und vergleiche die angeforderten Query- und Alias-Pfade mit dem bestehenden Health-Report. Prüfe die Beispiele im Issue, einschließlich wiederholter Tag-Parameter und /health/ui; erledigt ist es, wenn die Filter und Aliase den vorgesehenen Report zurückgeben und die UI diesen Report rendert.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, graphql
Bereich
api, observability, web-dev
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.