NSwag
Refit
Our great sponsors
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
NSwag
-
This week I released v2.1 of my text-templating library Weave that now uses Source Generators by default.
I'm mostly using it for C# API client generation from backend code - sort of similar to what a tool like NSwag Studio will do. I think NTypewriter has more flexibility though, and having a live view with the VS plugin makes development quick.
-
OpenAPI v4 Proposal
NSwag does a wonderful job of generating TypeScript clients from OpenAPI specs. Definitely give it a shot before killing your current setup.
https://github.com/RicoSuter/NSwag (It sucks in any OpenAPI yml, not just ones from Swashbuckle/C#)
- Looking for an alternative to NSwag
-
The Typescript ecosystem is exhausting
I use this https://github.com/RicoSuter/NSwag but it's designed for .Net backends to some extent. But you can use the client generation from the command line or manually with the standalone client app.
- Code generation from Swagger specification file
-
Tool for generating example API requests and responses from OpenAPI
Here are three tools that you can use to generate example API requests and responses from OpenAPI specifications. These tools should work well even if your schemas are deeply nested: Nswag (Command Line and GUI): Nswag is a Swagger/OpenAPI toolchain for .NET, TypeScript, and other platforms. It supports code generation, client generation, and API documentation. You can use NswagStudio, which is a graphical interface, or you can use the command line tool called "NSwag.exe" for generating example API requests and responses. GitHub: https://github.com/RicoSuter/NJsonSchema NswagStudio: https://github.com/RicoSuter/NSwag/wiki/NSwagStudio Dredd (Command Line): Dredd is a language-agnostic command-line tool for validating API descriptions against backend implementations. It supports OpenAPI, Swagger, and API Blueprint formats. Dredd can generate example requests and responses and validate whether your API implementation conforms to the API description. GitHub: https://github.com/apiaryio/dredd Documentation: https://dredd.org/en/latest/ Stoplight Studio (GUI): Stoplight Studio is a modern API design and documentation platform that supports OpenAPI and JSON Schema. It allows you to create, edit, and validate OpenAPI specifications and provides a powerful visual interface for generating example API requests and responses. Website: https://stoplight.io/studio/ GitHub: https://github.com/stoplightio/studio These tools should provide you with the ability to generate example API requests and responses from your OpenAPI specifications and handle deeply nested schemas.
- Help me to generate swagger json Net 6
-
Web API generate of swagger json file
I’ve got an ASP.NET Core web API - I integrate NSwag (which I prefer to Swashbuckle - personal preference), run the app locally to generate the actual JSON file. See https://github.com/RicoSuter/NSwag Then I have a Bicep file that creates the API from the OpenAPI specification. Sorry - I don’t do Terraform (most of the Azure samples are of Bicep, but it should be easy to convert).
-
Open API Generators for Typescript / Node?
I have actually found that, but I was hoping for something with more popularity. E.g. this one is for .NET: https://github.com/RicoSuter/NSwag ( you can also generate typescript clients). But I do not want to bring in the dependency to another language, if possible.
-
Best practices of create models for back-end commutation.
If your API exposes a Swagger definition, you can use NSwag (https://github.com/RicoSuter/NSwag) to generate the TypeScript API Client and Models for you. We found this eliminates errors due to TS and API DTO’s not matching
Refit
-
Exception Handling in C# Methods returning object
A lot of people have given you good replies, but have you looked at Refit?
-
Http calls on mobile, what is the preferred way / best practice
Another question that rises is, would it be better to use some HttpClient package to handle the requests, like Refit in combination with Polly. But then again, it seems Refit also uses the HttpClient factory, which was a bad thing according to the previous?
-
Refactor your dotNET HTTP Clients to Typed HTTP Clients
Define a Refit client interface with the following for each API endpoint, e.g. GET /foo:
-
HttpClient best approach
Use RestEase to create your own client library. Refit is a very similar and more popular library. IMO RestEase is an improvement over Refit and I prefer it, but either will solve your problems. Both are libs that have you build interfaces describing the API endpoints, then the library handles all the boilerplate code that calls HttpClient.
-
What your hidden nuget gems ?
Refit - simple, typed REST clients: https://github.com/reactiveui/refit
-
how to structure code for rest api calls
I'd advise using this https://github.com/reactiveui/refit tool for HTTP requests. It saves a lot of time for serialization, deserialization and exception handling.
-
Roadmap for transition from Java
Use Refit, and let manage the live of HttpClient. Also, Refit will give you a strongly typed client around an API. All you have to write is the interface. Ain't that neat ? If you can't, use the HttpClientFactory to create the HttpClient instance: https://learn.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests
-
ASP.NET Core - how to properly make a GET request?
Use RestEase to create your own client library. Refit is a very similar and more popular library. IMO RestEase is an improvement over Refit and I prefer it, but either will solve your problems. Both are libs that have you build interfaces describing the API endpoints, then the library handles all the boilerplate code that calls HttpClient.
-
Integration tests without API dependencies with ASP.NET Core and WireMock.Net
The controller is simple and use the Refit library to abstract the PokéAPI call and then, returns the data.
-
I love refit
To be fair, Refit is pretty great.
What are some alternatives?
openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
RestSharp - Simple REST and HTTP API Client for .NET
autorest - OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, PowerShell, Go, Java, Node.js, TypeScript, Python
Flurl.Http - Fluent URL builder and testable HTTP client for .NET
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
RestEase - Easy-to-use typesafe REST API client library for .NET Standard 1.1 and .NET Framework 4.5 and higher, which is simple and customisable. Inspired by Refit
Polly - Polly is a .NET resilience and transient-fault-handling library that allows developers to express policies such as Retry, Circuit Breaker, Timeout, Bulkhead Isolation, and Fallback in a fluent and thread-safe manner. From version 6.0.1, Polly targets .NET Standard 1.1 and 2.0+.
Simple.OData.Client
protobuf-net.Grpc - GRPC bindings for protobuf-net and grpc-dotnet
Ocelot - .NET API Gateway
Unchase.OpenAPI.Connectedservice - :scroll: Visual Studio extension to generate OpenAPI (Swagger) web service reference.