NSwag | OpenAPI toolchain for .NET , ASP.NET Core | REST library

by RicoSuter C# Version: 14.0.7 License: MIT

X-Ray Key Features Code Snippets(4)Community Discussions(10)Vulnerabilities Install Support

kandi X-RAY | NSwag Summary

NSwag is a C# library typically used in Web Services, REST, Swagger applications. NSwag has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can download it from GitHub.

NSwag | NJsonSchema | Apimundo | Namotion.Reflection.

Support

Quality

Security

License

Reuse

Support

NSwag has a medium active ecosystem.

It has 5901 star(s) with 1120 fork(s). There are 167 watchers for this library.

There were 7 major release(s) in the last 12 months.

There are 1575 open issues and 1659 have been closed. On average issues are closed in 270 days. There are 113 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of NSwag is 14.0.7

Quality

NSwag has 0 bugs and 0 code smells.

Security

NSwag has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

NSwag code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

NSwag is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

NSwag releases are available to install and integrate.

Installation instructions are not available. Examples and code snippets are available.

It has 31446 lines of code, 0 functions and 687 files.

It has low code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of NSwag

Get all kandi verified functions for this library.

NSwag Key Features

No Key Features are available at this moment for NSwag.

NSwag Examples and Code Snippets

Build errors after creating an openapi client via Connected Services

Lines of Code : 39

License : Strong Copyleft (CC BY-SA 4.0)

Copy

{
  "runtime": "NetCore31",
  "defaultVariables": "Configuration=Debug",
  "documentGenerator": {
    "fromDocument": {
      "url": "/swagger.json"
    }
  },
  "codeGenerators": {
    "openApiToCSharpClient": {
      "generateClientInter

How to dynamically change the API_BASE_URL from nswag generated typescript Angular client

TypeScript

Lines of Code : 18

License : Strong Copyleft (CC BY-SA 4.0)

Copy

ModuleA
    providers: [
        {
            provide: API_BASE_URL, useValue: 'your-desired-value',
        },
        CustomerQueryClient, // Client from NSWAG Generated File
        CustomerCommandClient // Client from NSWAG Generated

Linux NSwag NPM CLI-framework Microsoft.NETCore.App version 2.1.0 was not found

Lines of Code : 6

License : Strong Copyleft (CC BY-SA 4.0)

Copy

dotnet --list-sdks

./dotnet-install.sh -Version 2.1.805 --install-dir /usr/share/dotnet

nswag version /runtime:NetCore31

Secure file download

JavaScript

Lines of Code : 54

License : Strong Copyleft (CC BY-SA 4.0)

Copy

1. Microsoft.AspNetCore.StaticFiles // To Get MimeType
2. NSwag.Annotations // Map API Return Type to NSwag Generate Method Return Type

services.AddSwaggerGen(options =>
{
    // Swagger Configurations
    optio

Community Discussions

Trending Discussions on NSwag

NSwag autogenerated client does not show default values

Annotations on model properties in SwaggerUI

How can I setup NSwag openapi2tsclient to generate correct Datetime init function?

Writing OpenAPI schema and generating client code for HTTP API that responds with polymorphic array

.NET Core 3.1 - SAP Connector - Could not load type 'System.ServiceModel.Activation.VirtualPathExtension'

Request header 'Referer' is different between Hosted Blazor Webassembly, and non hosted Blazor Webassembly

Proper way to DI NSwag auto-generated client

*System.Text.Json* unable to load when VisualStudio is not installed

Swagger/NSwag keep decimal datatype

nswag error in .NET 5.0, Process is terminating due to StackOverflowException

QUESTION

NSwag autogenerated client does not show default values

Asked 2022-Apr-11 at 15:12

I have an api with Swagger enabled. In one of the endpoints, I have a request with some values set as default.

...

ANSWER

Answered 2022-Apr-11 at 15:12

I didn’t find a solution using NSwag by itself.

I therefore used the openapi package from Microsoft, in combination with Roslyn, to create a small application which reads the swagger Json definition, parses the source code of the generated client, and sets the default value attributes.

This works, and provides quite a bit of control, but I would still have preferred if it were a feature in NSwag.

Source https://stackoverflow.com/questions/71779598

QUESTION

Annotations on model properties in SwaggerUI

Asked 2022-Feb-25 at 01:34

I have built a ASP.Net Core 3.1 Web API, and I am interested in auto-generating documentation for my clients. I've followed the very simple instructions found here: Microsoft docs to install either NSwag or Swashbuckle in my project and in both cases I can see documentation for my APIs, but there are no descriptions on the model properties.

Java seems to have an @ApiModelProperty annotation for this, but I don't see a similar attribute in .Net. Is it possible to add descriptions for Model properties in either of these swagger implementations, that would show up in Schema section in the Swagger UI?

...

ANSWER

Answered 2022-Feb-25 at 01:34

Standard xml doc summary works for me.

Source https://stackoverflow.com/questions/71258401

QUESTION

How can I setup NSwag openapi2tsclient to generate correct Datetime init function?

Asked 2022-Feb-19 at 19:58

I have a BE API (.NET 5.0) and FE in React. I am using NSwag to generate swagger.json file and then openapi2tsclient to convert it to typescript file. Everything works grate. I have a base entity with Datetime in UTC. It is translated to swagger.json file as:

...

ANSWER

Answered 2022-Feb-19 at 19:58

I found out that this is not correct representation of UTC time

Source https://stackoverflow.com/questions/71187893

QUESTION

Writing OpenAPI schema and generating client code for HTTP API that responds with polymorphic array

Asked 2022-Feb-02 at 15:36

I'm trying to write an OpenAPI 3.0 schema for an HTTP API. One of its requests responds with a polymorphic array of objects something like this:

...

ANSWER

Answered 2022-Feb-02 at 15:30

Update as of 2nd Feb

Following further investigation and experimentation, I've made additional changes to the solution:

Type discriminator

The Swagger/OpenAPI 3.0 spec supports a feature related to inheritance and polymorphism whereby a property on a object can be used to discriminate its subtype. In the case of the getAll operation, this can be defined as follows in the schema:

Source https://stackoverflow.com/questions/70791679

QUESTION

.NET Core 3.1 - SAP Connector - Could not load type 'System.ServiceModel.Activation.VirtualPathExtension'

Asked 2022-Jan-17 at 16:40

I have a .NET Core 3.1 Application that's hosting REST services and I'm incorporating the SAP Connector utilities for some of the endpoints. I'm on Windows 10.

I'm running into an error through one of the endpoints when establishing new RfcConfigParameters by doing RfcConfigParameters parameters = new RfcConfigParameters()

The error trace is as follows:

...

ANSWER

Answered 2022-Jan-17 at 16:40

I guess, this is not what you would like to hear, but please check the release and support strategy of NCo 3.0. It says:

The supported Microsoft .NET Frameworks are 2.0, 3.0, 3.5, 4.0, 4.5, 4.6, 4.7, and 4.8.

This means .NET Core is not supported at all by NCo. .NET Core is not the same as the classic .NET framework. If your application must be a .NET Core application, I doubt that you will be able to use the current SAP NCo at all then.

Unfortunately, SAP also did not announce any NCo version for .NET Core environments yet.

Source https://stackoverflow.com/questions/70715180

QUESTION

Request header 'Referer' is different between Hosted Blazor Webassembly, and non hosted Blazor Webassembly

Asked 2022-Jan-12 at 14:40

I've been developing a hobby project in Blazor Webassembly ASP.NET Core hosted using the template Identity Server implementation, and have developed some authorization, which looks at the API calls from Blazor Webassembly, and uses the the request header 'Referer' to authorize.

The user has some subscriptions to some Teams they attend, and they can switch between them.

The URL has the Guid of what team page they are currently on, and when the Blazor Webassembly made an API call to the ASP.NET Core Web API, it would then look at the 'Referer' to find the Guid.

Here is the request header 'Referer' value as in hosted with ASP.NET Core

The 'Referer' value would be

...

ANSWER

Answered 2022-Jan-12 at 14:28

I figured it out after spending a lot of days on this.

The problem was that ASP.NET Core Hosted Blazor Webassembly calls the API with the same Origin, so the 'Referrer Policy': 'origin-when-cross-origin' did not restrict the 'Referer' header.

'origin-when-cross-origin' is the standard for 'Referrer Policy', and restricts the 'Referer' header for cross-origin calls.

But when I ran it with Blazor Webassembly and ASP.NET Core Web API each in their own project, they were localhost:7004 and localhost:7170, which are seen as same-site but not same-origin, so it was restricted to only show 'Origin' as the 'Referer' header.

I can't seem to find any way to make the API and Blazor be from the same 'Origin', so I have made my application somewhat less secure for now, by setting in my index.html file in Blazor Webassembly.

My application does not send user sensitive information in the URL ever, and everything is using HTTPS, so it isn't really that much of a problem if the 'Referer' is read by an external source.

I will be looking at a better solution to tell my API from what Team the caller is trying to access content, to check if the caller also has the policy in the JWT to access it, but for now this will do.

Source https://stackoverflow.com/questions/70636523

QUESTION

Proper way to DI NSwag auto-generated client

Asked 2021-Dec-04 at 10:51

What is the preferred way to make a VS connected service (NSwag) injected into classes/controllers. I have found a lot of suggestions on the net to use this form:

...

ANSWER

Answered 2021-Sep-26 at 13:24

Ok, I actually solved this problem by poking around through OpenApiReference, but it requires manual modification of csproj file. Additional Options node has to be added to OpenApiReference item group, to instruct NSwag to NOT expose BaseUrl and to also generate an interface, which eases the work with setting up DI without additional code.

Visual Studio team should really add these two checkboxes to Connected Services screens/configuration for OpenAPI.

Source https://stackoverflow.com/questions/69333244

QUESTION

*System.Text.Json* unable to load when VisualStudio is not installed

Asked 2021-Nov-03 at 16:46

I have a DLL based on netcoreapp3.1. The DLL references the NuGet package Microsoft.Extensions.Configuration.Json version 5.0.0. If I deploy the DLL to another PC where VisualStudio is not installed and try to access it from a third party program, I get the error:

...

ANSWER

Answered 2021-Nov-03 at 16:46

Check dependencies: https://www.nuget.org/packages/Microsoft.Extensions.Configuration.Json/

this version requires for you to use one of:

.net framework >= 4.6.1
.net standard >= 2.0
.net core 5.0

so if you have requirements for netcoreapp3.1 you need to use the version 3.1.20 or lower

Source https://stackoverflow.com/questions/69828440

QUESTION

Swagger/NSwag keep decimal datatype

Asked 2021-Oct-12 at 12:01

I do have my .net data classes, containing a few decimal fields (for example quantity). I generate an openapi.json out of it running dotnet swagger.

...

ANSWER

Answered 2021-Oct-11 at 19:05

Try adding this line into your .AddSwaggerGen() definition

Source https://stackoverflow.com/questions/69523654

QUESTION

nswag error in .NET 5.0, Process is terminating due to StackOverflowException

Asked 2021-Aug-09 at 09:53

I am using aspnetzero framework. After upgrading .Net core to .Net5, I am facing an issue when running refresh.bat. It's throwing below mentioned error

Executing file '..\EMA.Web.Host\nswag\service.config.nswag' with variables 'Process is terminating due to StackOverflowException. child_process.js:656 throw err;'

Error: Command failed: dotnet "E:....\node_modules\nswag\bin/binaries/NetCore21/dotnet-> nswag.dll"

nswag version updated to 13.12.1.

When I run 'http://localhost:5000/swagger/v1/swagger.json', I am getting updated json.

Not sure why its causing Stack overflow exception, any pointers to resolve this issue?

Thanks.

...

ANSWER

Answered 2021-Aug-09 at 09:53

Type JObject and JToken were causing this stackoverflow exception, removing them fixed the error.

Source https://stackoverflow.com/questions/68678198

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install NSwag

You can download it from GitHub.

Support

Companies or individuals which paid a substantial amount for implementing, fixing issues, support or sponsoring are listed below. Thank you for supporting this project! You can also become a financial contributor:. Please contact Rico Suter for paid consulting and support.

Find more information at: