How to omit methods from Swagger documentation on WebAPI using Swashbuckle

📝💻🚀 How to Omit Methods from Swagger Documentation on WebAPI using Swashbuckle

Are you struggling to omit certain methods from your Swagger documentation in your C# ASP.NET WebAPI application? If so, you're in the right place! In this blog post, we'll explore a simple solution using the popular Swashbuckle library. Let's dive in!

The Challenge: Omitting Methods from Swagger Documentation

So, you have your API documentation beautifully generated by Swashbuckle, but you want to exclude specific methods that are not relevant or should not be exposed. The question is, how can you remove these methods from the Swagger UI output?

The Solution: Adding a Model or Schema Filter

Luckily, the solution lies in adding a model or schema filter to your Swashbuckle configuration. This allows you to modify the output for a method and even remove it completely from the documentation. Let's see how it works.

1. First, make sure you have Swashbuckle added to your project. If not, you can install it via NuGet.

   Install-Package Swashbuckle

2. Locate the Swagger configuration in your project. This is commonly done in the SwaggerConfig.cs file.

3. Inside the Swagger configuration, find the line where the EnableSwagger method is called. It should look something like this:

   GlobalConfiguration.Configuration.EnableSwagger();

4. Right after the EnableSwagger method call, you can add a filter using the GlobalConfiguration.Configuration.ConfigureSwaggerUi method. Here's an example of how to exclude a specific method:

   GlobalConfiguration.Configuration.ConfigureSwaggerUi(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your API Title"); // Omitting a method from Swagger documentation c.DocExpansion(DocExpansion.None) .ModelFilter<ExcludeMethodFilter>(); // Add this line });

5. Now, let's create the ExcludeMethodFilter class. This class will implement the IModelFilter interface provided by Swashbuckle. Here's an example implementation:

   public class ExcludeMethodFilter : IModelFilter { public void Apply(Schema model, ModelFilterContext context) { // Check if it's the method you want to omit if (context.SystemType == typeof(YourController).GetMethod("MethodName")) { // Exclude the method from documentation model.Extensions.Add("x-exclude-from-swagger", true); } } }

   In this example, you need to replace YourController with the name of your controller and MethodName with the name of the method you want to exclude.

6. Save the file, build your project, and run it.

Now, when you access your Swagger UI, the specified method should be successfully omitted from the documentation!

Conclusion

We hope this guide has helped you to overcome the challenge of omitting methods from Swagger documentation using Swashbuckle. By adding a model or schema filter, you can easily exclude specific methods, keeping your API documentation clean and relevant.

So, what are you waiting for? Give it a try in your own project and let us know how it works for you! If you have any questions or suggestions, feel free to leave a comment below.

Happy coding! 💻🚀