openapi-typescript
zod
openapi-typescript | zod | |
---|---|---|
17 | 288 | |
4,591 | 30,347 | |
- | - | |
9.3 | 9.1 | |
3 days ago | 6 days ago | |
TypeScript | TypeScript | |
MIT License | 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.
openapi-typescript
- TypeSpec: A New Language for API-Centric Development
-
Writing type safe API clients in TypeScript
OpenAPI TypeScript
-
Django 5.0 Is Released
I'll preface all of this with a couple esoteric design goals that I had in mind:
1. I actually _want_ an SPA. You might not need an SPA, if you don't need one then Vue/React/etc are overkill, etc.
2. I want to power as much of the SPA as I can using the same REST API as my core product, both for dogfooding reasons and for consolidation. Many people might argue that this is a bad idea.
---
With that in mind, some specific packages that I highly recommend:
1. Django-vite (https://github.com/MrBin99/django-vite). This makes it very easy to serve an SPA from the actual django response/request model
2. Some sort of way to get type information (if you're using TypeScript) into the frontend. I use a frankensteined system of the OpenAPI spec that django-ninja generates + openapi-typescript (https://github.com/drwpow/openapi-typescript). This means when I add, say, a new field to a response in Django, I immediately get typechecking for it in Vue — which has been _tremendously_ useful.
3. Django-typescript-routes (a package I extracted and open-sourced!: https://github.com/buttondown-email/django-typescript-routes) which gives your front-end routing information based on the Django router.
- OpenAPI-TypeScript – OpenAPI schemas in TypeScript
-
Tell HN: Postman just wiped all my stuff
Glad to see alternatives but disappointed that Bruno does not support OpenAPI specification.
At my company, we hand-edit OpenAPI specs in YAML and it gets consumed by many tools that generate types[0], static analysis and dynamic checks[1]. The OpenAPI spec itself is linted[2]. And of course, Postman consumes OpenAPI.
Tools that are built on open standards will naturally see greater adoption over those that use proprietary formats.
[0]: https://openapi-ts.pages.dev
-
tRPC – Move Fast and Break Nothing. End-to-end typesafe APIs made easy
Another great library to generate TS types from OpenAPI is https://github.com/drwpow/openapi-typescript . It provides the types as single objects you access via indexing, which is pretty nice. There's a partner library to generate a typed fetch client.
-
How can I generate typescript types?
If you're willing to document your API with an OpenAPI schema, then it should be possible to generate TypeScript types based on the OpenAPI schema with something like openapi-typescript. Also, Typebox can generate JSON schemas, maybe it can be used to generate something that the front-end can also use?
-
Should I add Redux?
REST
-
Building a Secure Database-Centric OpenAPI in 15 Minutes
In this sample, we'll achive it using openapi-typescript and openapi-typescript-fetch.
- GRPC Gateway API Client?
zod
-
From Flaky to Flawless: Angular API Response Management with Zod
Zod is an open-source schema declaration and validation library that emphasizes TypeScript. It can refer to any data type, from simple to complex. Zod eliminates duplicative type declarations by inferring static TypeScript types and allows easy composition of complex data structures from simpler ones. It has no dependencies, is compatible with Node.js and modern browsers, and has a concise, chainable interface. Zod is lightweight (8kb when zipped), immutable, with methods returning new instances. It encourages parsing over validation and is not limited to TypeScript but works well with JavaScript as well.
- TypeScript Essentials: Distinguishing Types with Branding
-
You can’t run away from runtime errors using TypeScript
Zod is a TypeScript-first schema declaration and validation library. It helps create schemas for any data type and is very developer-friendly. Zod has the functional approach of "parse, don't validate." It supports coercion in all primitive types.
-
Best Next.js Libraries and Tools in 2024
Link: https://zod.dev/
-
Popular Libraries For Building Type-safe Web Application APIs
You can check out their documentation here.
-
Epic Next JS 14 Tutorial Part 4: How To Handle Login And Authentication in Next.js
You can learn more about Zod on their website here.
-
What even is a JSON number?
In JS, it's a good idea anyway to use some JSON parsing library instead of JSON.parse.
With Zod, you can use z.bigint() parser. If you take the "parse any JSON" snippet https://zod.dev/?id=json-type and change z.number() to z.bigint(), it should do what you are looking for.
-
Error handling in our form component for the NextAuth CredentialsProvider
We will validate our input using client-side zod. Zod handles TypeScript-first schema validation with static type inference. This means that it will not only validate your fields, it will also set types on validated fields.
-
Zod: Zero to Hero - Chapter 4
A word of warning: while discriminated unions are very powerful, there's an ongoing discussion on whether discriminated unions should be deprecated and replaced with a different API.
-
Zod: Zero to Hero - Chapter 1
I was first introduced to Zod by Adam Bobrow - a colleague of mine and a dear friend. Adam was sick and tired from JavaScript's brittleness, and about two years ago he started migrating our code base to TypeScript. But that wasn't enough for him. He kept complaining: "What good are my types, if some other service decides to send me bad data and breaks my code?". That's when he discovered Zod.
What are some alternatives?
routing-controllers - Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage in Express / Koa using TypeScript and Routing Controllers Framework.
class-validator - Decorator-based property validation for classes.
remult - Full-stack CRUD, simplified, with SSOT TypeScript entities
joi - The most powerful data validation library for JS [Moved to: https://github.com/sideway/joi]
proposal-decorators - Decorators for ES6 classes
Yup - Dead simple Object schema validation
nestjs-openapi3 - OpenAPI 3.x document generation and serving for NestJS.
typebox - Json Schema Type Builder with Static Type Resolution for TypeScript
nestjs-auth - Comprehensive handling of authentication and authorization for NestJS.
ajv - The fastest JSON schema Validator. Supports JSON Schema draft-04/06/07/2019-09/2020-12 and JSON Type Definition (RFC8927)
openapi-comment-parser - ⚓️ JSDoc Comments for the OpenAPI Specification
io-ts - Runtime type system for IO decoding/encoding