Home - microsoft/OpenAPI.NET.CSharpAnnotations GitHub Wiki

Welcome to the OpenAPI.NET C# Annotation Document Generator wiki!

Introduction

OpenAPI.NET C# Document Generator utilizes native VS XML annotations to construct the OpenAPI document for the service.

First, make sure that you have enabled your XML annotations for your project to be dropped as part of the Build output. This XML file is needed as an input to the C# Comment Reader.

To do so, in Visual Studio, right click on your project and Select Properties. Then choose the Build tab, scroll down to Output section and ensure that XML documentation file is checked. Set the file path to: bin\[YourServiceName].XML or another file path of your choosing.

Annotation Guides

• Buildable Code Sample.

• C# Comment Tag-By-Tag Guide.

• C# Comment Samples

• Advanced Configuration XML : This allows you to control which operations to include or exclude from the resulting documents or add certain annotations to all or some operations.