To generate the Swagger/OpenAPI specification for a controller in a. NET Core Runtime IDentifier (RID) catalog for more information about runtimes.įirst publish your project with dotnet publish, then add the DLL with the controllers to the AssemblyPaths from the publish output directory. Important: Choose the correct Runtime in NSwagStudio or use the /runtime:NetCore21 setting with the NSwag.NPM package.ĭotnet publish -self-contained -runtime your_runtime The following sections show how to compile your project in a way so that all required DLLs are in the output directory. NET Core does not output all referenced DLLs, some are looked up from the NuGet cache when running the app. ConfigurationPath: The path to the app.config or web.config, this is usually not needed but may avoid problems if binding redirects are required.ReferencePaths: Specifies paths to directories where additional dependent assemblies are looked up.All required dependent assemblies are looked up in the same directory or subdirectories. AssemblyPaths: Specifies the paths to DLLs (usually only one) where the controller types are found.
The important settings for loading assemblies are: NSwagStudio, runtime will be WinX64 or WinX86) Debug: Creates a new AppDomain in the current process (full.Default: Uses the runtime of the current process with no checks.NSwag.MSBuild: AppDomain or AssemblyLoadContext via different $ propertiesĪvailable runtimes (set via /runtime:WinX64):.NSwag.NPM: AppDomain or AssemblyLoadContext via /runtime:NetCore20 switches.NSwagStudio: NSwagStudio starts one of the NSwag command line binaries, selected with the Runtime setting.WebApiOpenApiDocumentGenerator: Uses AppDomain or AssemblyLoadContext depending in which environment (full.This page gives you some tips how to properly configure NSwag to load assemblies:
The package NSwag.MSBuild provides different variables to access a specific binary. With the NSwag.NPM package, you can select the runtime with the /runtime:WinX64 setting.
NSwagStudio internally starts one of the NSwag command line binaries depending of the selected Runtime (the default uses the same runtime as NSwagStudio - i.e. To avoid problems with this process, you should use the NSwag binary of the same runtime as the assembly to load. However, this process may be tricky - for example, because some required DLLs are missing or NSwag runs with newer versions of libraries than the loaded Web API or ASP.NET Core assembly. This is required to generate the OpenAPI specification outside of a running ASP.NET process, i.e. Then the selected assemblies are loaded in a separate AppDomain (when host is running on full. When a Swagger specification is generated with either the
0 kommentar(er)
