RicoSuter/NSwag

How to create an example of request object?

Open

#2 446 ouverte le 5 oct. 2019

Voir sur GitHub
 (11 commentaires) (3 réactions) (0 assignés)C# (1 189 forks)batch import
help wantedtype: enhancement

Métriques du dépôt

Stars
 (6 291 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Do we support example values for request objects?

		public async Task<ActionResult<IEnumerable<DummyDto>>> GetConfigurations(
			[FromQuery] DummyQueryDto query) =>
			Ok(await configurationRepository.GetQueryable()
				.ProjectTo<DummyDto>(m_mapper.ConfigurationProvider)
				.ApplyFilter(query.ToFilter())
				.ApplySorting(query.ToSorter())
				.ApplyPagination(query.Offset, query.Count).ToListAsync());
	}

How do I supply example value for this DummyQueryDto object into Swagger UI?

I use OpenApi, SwaggerUi3, AddOpenApiDocument - a really basic setup.

Is there a support for Swashbuckle.AspNetCore.Filters ?

Guide contributeur

Direction de recherche
Examinez la documentation et le code source de NSwag pour déterminer s'il existe une prise en charge intégrée des valeurs d'exemple sur les objets de requête. Si aucune n'existe, fournissez des conseils sur la façon dont les utilisateurs peuvent spécifier manuellement des exemples via le contrat de l'API ou suggérez un contournement. Envisagez de vous référer à des problèmes similaires ou à la bibliothèque Swashbuckle.AspNetCore.Filters mentionnée par l'OP.
Stack technique
csharp
Domaine
api
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C#.NETNSwag
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75