http-spec
NSwag
http-spec | NSwag | |
---|---|---|
18 | 40 | |
19 | 6,494 | |
- | - | |
6.1 | 8.7 | |
6 days ago | 10 days ago | |
TypeScript | C# | |
Apache License 2.0 | MIT License |
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.
http-spec
- The most effective Schema-Driven Development using OpenAPI for Logistic Engineer
- Spotlight: Sentry for Development
-
Testing an OpenAPI specification in PHP
However, we do not need to write the specification by hand, as there are GUI editors to perform that task. We show a couple of examples of Spotlight, which provides an easy-to-use interface:
-
Rapid Prototyping of Design-First APIs in Go
We use Stoplight Studio https://stoplight.io/ to design APIs, one of the advantages of Stoplight Studio is the Visual interface, it generates OpenAPI specs from the design and supports OpenAPI v3, allowing users to create, edit, and view API designs using the OpenAPI standard.
-
OpenAPI v4 Proposal
I'm sorry, but you have completely misunderstood the purpose of Open API.
It is not a specification to define your business logic classes and objects -- either client or server side. Its goal is to define the interface of an API, and to provide a single source of truth that requests and responses can be validated against. It contains everything you need to know to make requests to an API; code generation is nice to have (and I use it myself, but mainly on the server side, for routing and validation), but not something required or expected from OpenAPI
For what it's worth, my personal preferred workflow to build an API is as follows:
1. Build the OpenAPI spec first. A smaller spec could easily be done by hand, but I prefer using a design tool like Stoplight [0]; it has the best Web-based OpenAPI (and JSON Schema) editor I have encountered, and integrates with git nearly flawlessly.
2. Use an automated tool to generate the API code implementation. Again, a static generation tool such as datamodel-code-generator [1] (which generates Pydantic models) would suffice, but for Python I prefer the dynamic request routing and validation provided by pyapi-server [2].
3. Finally, I use automated testing tools such as schemathesis [3] to test the implementation against the specification.
[0] https://stoplight.io/
[1] https://koxudaxi.github.io/datamodel-code-generator/
[2] https://pyapi-server.readthedocs.io
[3] https://schemathesis.readthedocs.io
- Swagger Hub alternatives
-
Examples of API Governance?
One of the best tools out there for API design and governance https://stoplight.io/ you can also use the open source tool (also from Stoplight) called Spectral https://stoplight.io/open-source/spectral
-
Review: 10 Top API Mock Tools
Stoplight is a platform for designing, documenting, and testing APIs. Its "Mocks" feature allows you to create mock versions of your API for testing and development purposes. In addition to the mock feature, Stoplight also includes tools for API design, documentation, and testing, making it a comprehensive platform for API development.
-
💰 My Frugal Indie Dev Startup Stack
Stoplight
-
API Product Managers vs. API Developers
JSON visualizer JSON validator YAML validator Collaborative Design & Documentation for APIs
NSwag
-
TypeSpec: A New Language for API-Centric Development
https://github.com/RicoSuter/NSwag
There is no need to be facetious solutions like these exist for many platforms and ecosystems out there.
With best regards.
-
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.
What are some alternatives?
fern - 🌿 Stripe-level SDKs and Docs for your API
openapi-generator - OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
postcat - Postcat 是一个可扩展的 API 工具平台。集合基础的 API 管理和测试功能,并且可以通过插件简化你的 API 开发工作,让你可以更快更好地创建 API。An extensible API tool.
autorest - OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, PowerShell, Go, Java, Node.js, TypeScript, Python
OneSDK - 1️⃣ One Node.js SDK for all the APIs you want to integrate with
Refit - The automatic type-safe REST library for .NET Core, Xamarin and .NET. Heavily inspired by Square's Retrofit library, Refit turns your REST API into a live interface.
oatx - Generator-less JSONSchema types straight from OpenAPI spec
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
hoverfly - Lightweight service virtualization/ API simulation / API mocking tool for developers and testers
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+.
rest-api-standards - An open collection of REST API standards documents
protobuf-net.Grpc - GRPC bindings for protobuf-net and grpc-dotnet