1 dépôt
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 est un outil de spécification d'API et un générateur de documentation pour ASP.NET Core. Il extrait les métadonnées du code source et des modèles pour produire des spécifications OpenAPI standardisées et des interfaces de navigateur interactives pour explorer et tester les API web. Le projet intègre un composant middleware pour servir ces spécifications et une interface Swagger UI pour le test d'API interactif directement depuis une application en cours d'exécution. Il fournit également un exportateur en ligne de commande pour extraire les fichiers de spécification des assemblages d'application pour une utilisation dans les pipelines CI/CD. L'outil couvre un large éventail de capacités incluant la gestion de schéma pour les types complexes, l'annotation de métadonnées via des attributs et des commentaires XML, et la configuration de sécurité pour OAuth 2.0 et les clés API. Il prend en outre en charge la gestion de contrat d'API, le versionnage de spécification et des pipelines de génération personnalisables pour filtrer ou modifier les opérations.
Defines descriptions and requirement flags for path, query, and header parameters to clarify input expectations.