Skip to content

Controllers and Response Objects

Emma Corbett edited this page Jun 25, 2020 · 7 revisions

Maps straight to JSON - should match planned swagger hub doc

Auto-generated swagger docs

We use swashbuckle to auto-generate swagger documentation, based on the code in the controller class and the response objects. You can see the docs that the API has produced by going to baseurl/swagger/index.html (http://localhost:5000/swagger/index.html if running the API locally).

You can add extra documentation and detail to your swagger docs by adding XML comments to the code. Documentation on which how to write these comments and how they render in the swagger UI can be found in Microsoft's documentation or swashbuckle's documentation.

Clone this wiki locally