RicoSuter/NSwag

How to create an example of request object?

Open

#2,446 opened on Oct 5, 2019

View on GitHub
 (11 comments) (3 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedtype: enhancement

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

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 ?

Contributor guide

Research direction
Check NSwag documentation for request object examples and look for IOperationProcessor usage. Review test projects for sample configurations.
Tech stack
csharp
Domain
api
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#.NETNSwag
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75