1 Repo
Use of attributes to define descriptions and requirement flags for API path, query, and header parameters.
Distinct from Field-Level Metadata Annotations: Focuses on documenting API input parameters specifically.
Explore 1 awesome GitHub repository matching development tools & productivity · Parameter Metadata Annotations. Refine with filters or upvote what's useful.
Swashbuckle.AspNetCore ist ein API-Spezifikationstool und Dokumentationsgenerator für ASP.NET Core. Es extrahiert Metadaten aus Quellcode und Modellen, um standardisierte OpenAPI-Spezifikationen und interaktive Browser-Interfaces zum Erkunden und Testen von Web-APIs zu produzieren. Das Projekt integriert eine Middleware-Komponente zur Bereitstellung dieser Spezifikationen sowie eine Swagger-UI für interaktives API-Testing direkt aus einer laufenden Anwendung heraus. Es bietet zudem einen CLI-Exporter, um Spezifikationsdateien aus Anwendungs-Assemblies für den Einsatz in CI/CD-Pipelines zu extrahieren. Das Tool deckt ein breites Spektrum an Funktionen ab, einschließlich Schema-Management für komplexe Typen, Metadaten-Annotation via Attribute und XML-Kommentare sowie Sicherheitskonfiguration für OAuth 2.0 und API-Keys. Es unterstützt zudem API-Contract-Management, Spezifikations-Versioning und anpassbare Generierungs-Pipelines zum Filtern oder Modifizieren von Operationen.
Defines descriptions and requirement flags for path, query, and header parameters to clarify input expectations.