How to add authentication to nswag documentGenerator

Question

I have a nswag.json file with my configuration to generate c# http clients. However, the swagger url that I want to point to is protected with Http basic auth.

Is it possible to add to the configuration file the necessary username and password?

Something that would look like this (from documentGenerator section in nswag.json):

"documentGenerator": {
"fromDocument": {
  "url": "https://example.com/swagger/v1/swagger.json",
  "output": null,
  "newLineBehavior": "Auto",
  "authorization": {
    "type": "Basic",
    "username": "example",
    "password": "example"
  }
}

Thanks in advance!

score 0 · Answer 1 · answered Jul 12 '23 at 19:46

0

From what I can tell there is no way to achieve this like that https://github.com/RicoSuter/NSwag/blob/master/src/NSwag.Commands/Commands/Generation/FromDocumentCommand.cs

Not sure if this helps but you can put in the raw Json, under the json field instead of the url field.

answered Jul 12 '23 at 19:46

Zach Hutchins

801
1
12
16

Based on your suggestion I came up with a solution which I posted as right answer for my question. Thank you for the feedback – João Fernandes Jul 19 '23 at 13:13

score 0 · Accepted Answer · answered Jul 19 '23 at 13:11

I was able to achieve what I wanted by having a script executed before nswag in the same pre build event. With the script I could add authentication headers to fetch swagger specification from the API (.../swagger.json). After that, the swagger file is saved in the project directory and is used by nswag to generate the clients. Document generator in Nswag file looks something like this:

"documentGenerator": {
"fromDocument": {
  "json": "./swagger.json",
  "output": null,
  "newLineBehavior": "Auto"
}

}

Pre build event:

<Target Name="PreBuild" BeforeTargets="BeforeBuild">
    <Exec ConsoleToMsBuild="true" WorkingDirectory="$(ProjectDir)" Command="python swagger_download.py" />
    <Exec ConsoleToMsBuild="true" WorkingDirectory="$(ProjectDir)" Command="$(NSwagExe_Net60) run nswag.json /variables:Configuration=$(Configuration)" />
    <ItemGroup>
        <Compile Include="GeneratedClients\*.cs" />
    </ItemGroup>
</Target>

How to add authentication to nswag documentGenerator

2 Answers2