Documenting ASP.NET Core 2.0 Web API

Problem

How to add documentation and help pages for ASP.NET Core Web API.

Solution

Add NuGet package - Swashbuckle.AspNetCore

Update the Startup class to add services and middleware for Swagger.

The help page can be accessed via: [host]/swagger



Discussion

Swagger is a format to describe RESTful APIs and Swashbuckle generates these swagger documents.

Note

The name specified when configuring services via SwaggerDoc
method (e.g. “help” our sample code) must be the same as specified in the SwaggerEndpoint method.

XML Documentation

Documents generated by Swagger can include XML documentation. This can be turned on from project Properties > Build tab and configuring swagger services.

Using XML comments, data annotations on model and action attributes we can produce detailed documentation that would be useful for the client developers, e.g.:

Source Code

GitHub

X

Build smarter apps with Machine Learning, Bots, Cognitive Services - Start free.

Start Learning Now