Add custom annotations to generated classes

[florianh77]

Is it possible to add custom annotations when generating c# server or client classes? I would like the same models when communicating to the backend using RPC.

[davidkeaveny]

I'm guessing you could achieve this by providing customised Liquid templates, which add the necessary attributes in addition to, or instead of, the ones that NSwag applies by default.

[Parcley]

I have a very similar use-case like @florianh77: I want to add [ExcludeFromCodeCoverage] to every generated class (as this is the annotation that is understood by our code coverage tool). @davidkeaveny I find your answer interesting and I have also found some resources which point me one step further:

• this seems to be the template for adding Client Annotation: https://github.com/RicoSuter/NSwag/blob/master/src/NSwag.CodeGeneration.CSharp/Templates/Client.Class.Annotations.liquid
• this document refers to a TemplateDirectory setting, which I am unsure where to set: https://github.com/RicoSuter/NSwag/wiki/Templates

[davidkeaveny]

@Parcley it's probably easiest to use NSwagStudio, which provides a more user-friendly approach to setting up the .nswag configuration file. When configuring the CSharp Client, it's near the bottom of the configuration page, in a section labelled Templating in a field named Template Directory; it should be sufficient to use a path that is relative to your .nswag file.

If you want to edit the .nswag file by hand, then the relevant section of the configuration looks something like this:

{
  "codeGenerators": {
    "openApiToCSharpClient": {
      "templateDirectory": "Templates"
    }
  }
}