sig-moonwalk
swagger-typescript-api
sig-moonwalk | swagger-typescript-api | |
---|---|---|
6 | 15 | |
250 | 2,951 | |
4.4% | 3.5% | |
6.0 | 5.4 | |
about 1 month ago | 4 days ago | |
TypeScript | ||
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.
sig-moonwalk
- OpenAPI v4 (aka Moonwalk) Proposal
-
OpenAPI v4 Proposal
One of the Moonwalk discussions is indeed about moving from objects to arrays for many structures: https://github.com/OAI/moonwalk/discussions/32
Also, I agree with the person who mentioned JSON Patch (RFC 6902), which I feel is an under-rated and underused technology. While less intuitive than JSON Merge Patch (RFC 7396), it is far more powerful. I have used both together, using JSON Merge Patch where possible to keep things more readable and intuitive, and using JSON Patch where JSON Merge Patch can't do what is needed. Although if most of your changes need JSON Patch, I find it's better to just stick with that.
-
OpenAPI 3.1 - The Gnarly Bits
Why not get involved in the discussions around a tentative OpenAPI 4.0, codename 'Moonwalk'?
swagger-typescript-api
-
Generative HTTP API Clients
RESTful APIs via swagger-typescript-api
-
Gentle Introduction To Typescript Compiler API
TypeScript API generator via Swagger scheme
- JavaScript Gom Jabbar
-
OpenAPI v4 Proposal
You said it yourself — the “official” generator is awful and very hard to modify or extend (well, you didn’t say that, but I’m saying it) and while there are many alternatives, they’re not always easy to find. I had some success with swagger-typescript-api[1], but eventually got tired of it and wrote my own generator. Despite looking around quite a bit at what’s available, I never heard of openapi-codegen, which looks quite good.
[1]: https://github.com/acacode/swagger-typescript-api
-
Fastest Way to Auto Generate Types for Typescript and ZOD Schema
A lot of APIs nowadays have a Swagger / OpenAPI spec. You can autogenerate types from that using tools like swagger-typescript-api.
-
I am so bad at connecting and debugging APIs
With such a contract your BE team should provide a https://swagger.io/tools/swagger-ui/ where the API definition can easily be viewed and tested. Also you can use generators to basically generate a boilerplate (types for all models, functions for all requests) for the entire API based on a contract: https://github.com/acacode/swagger-typescript-api This his already saved me months of work.. great tool.
-
Is putting all api calls in map actions and map getters a recommended pattern?
If your backend is using Swagger, I'd highly recommend using the package swagger-typescript-api. It auto-generates your types and endpoints for you, based on a swagger.json file, which then simplifies where I store my API calls. The flexibility of this is that I can use these API calls in components, classes, Vuex, etc., and I'm not tied to something that I have to maintain as a UI dev.
- Making an API wrapper with TypeScript
- Swagger-autogen with Typescript
-
[AskJS] What's a good option for building a backend with minimal glue code for the frontend?
If your backend is able to generate Swagger/OpenAPI JSON, you can use https://github.com/acacode/swagger-typescript-api to generate both TypeScript interfaces and an API client from the Swagger JSON.
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)
utoipa - Simple, Fast, Code first and Compile time generated OpenAPI documentation for Rust
swagger-ui - Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
effect-http - Declarative HTTP API library for effect-ts
fastify-typescript-generator - generates new fastify applications in everyone's favourite language typescript with various options to choose from based on your project needs
oatx - Generator-less JSONSchema types straight from OpenAPI spec
NSwag - The Swagger/OpenAPI toolchain for .NET, ASP.NET Core and TypeScript.
swag - Automatically generate RESTful API documentation with Swagger 2.0 for Go.
NetHack - Official NetHack Git Repository
speakeasy - Speakeasy CLI - Enterprise developer experience for your API
openapi-typescript-codegen - NodeJS library that generates Typescript or Javascript clients based on the OpenAPI specification