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
I find it odd that you've struggled so much with generating API clients. I've generated C# and TypeScript (Angular's HttpClient and React Query) clients for my API and never had any issues with them. With that being said, I didn't use OpenAPI's Java-based code generators and rather used ones made by third-party developers such as NSwag[0] and openapi-codegen[1].
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.
-
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
- In Visual Studio 2022 Is there a way to generate a function from an OpenApi yaml file
-
What class should I create to deserialize this?
There are Swagger v2/OpenAPI v3 specifications in the repository. Could you use NSwag or (if you have Visual Studio) the Connected Services tools? That'll make a client and all the necessary types for you.
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?
-
HttpClient best approach
It doesn’t seem to be maintained anymore: https://github.com/reactiveui/refit/discussions/1461
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
-
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.
-
What is the best practice to send query parameters / data on http client get method?
I would add Refit to that list https://github.com/reactiveui/refit
What are some alternatives?
RestSharp - Simple REST and HTTP API Client for .NET
Flurl.Http - Fluent URL builder and testable HTTP client for .NET
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
openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
autorest - OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, PowerShell, Go, Java, Node.js, TypeScript, Python
Simple.OData.Client
Ocelot - .NET API Gateway
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+.
practical-clean-ddd - 🕸 Yet Another .NET Clean Architecture, but for Microservices project. It uses Minimal Clean Architecture with DDD-lite, CQRS-lite, and just enough Cloud-native patterns apply on the simple eCommerce sample and run on Tye with Dapr extension 🍻
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
WebApiClient - An open source project based on the HttpClient. You only need to define the c# interface and modify the related features to invoke the client library of the remote http interface asynchronously.
protobuf-net.Grpc - GRPC bindings for protobuf-net and grpc-dotnet