Need to add existing model (not inline) to Swagger schemas in .Net core API

Question

I am generating Swagger document for my .Net core 6 based API. I have some error models which will be returned by my Gateway. These are not used/returned in any of my API endpoints. I want to add these models to Swagger document schema collection. I am able to successfully add them if I follow inline way. Is there a way to include existing models in Swagger schema collection?

I also want to include webhook models and examples to schemas collection without going through inline option.

Thanks for your time.

@CodingMytra - thank you for your comment. I have created a model (ex: GWErrorModel.cs) like below. I want to inject this into schema collection, so that I can refer it in all responses of all my endpoints. public class GWErrorModel { public string status { get; set; } public string errorMessage { get; set; } } — streamingpro
– streamingpro, Commented Aug 1, 2022 at 13:23

CodingMytra · Accepted Answer · 2022-08-02 04:30:19Z

You can do following to add the model to schema collection.

Create a custom document filter

public class CustomDocumentFilter : IDocumentFilter { public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context) { context.SchemaGenerator.GenerateSchema(typeof(GWErrorModel), context.SchemaRepository); } }

add it to program.cs

 builder.Services.AddSwaggerGen(o => { o.DocumentFilter<CustomDocumentFilter>(); });

you will see the model is added to schema collection.

Hope it helps.

Wonderful. Thank you so much for the answer, sample code and your time.
This seems to no longer work in .NET 8. The signature of the Apply meethod has changed and it's not clear how to achieve this with the new schema.
@Konstantin, which version of swashbuckle are you talking about. I can see still same definition of Apply method in IDocumentFilter

Collectives™ on Stack Overflow

Need to add existing model (not inline) to Swagger schemas in .Net core API

1 Answer 1

4 Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Linked

Related