phero
OpenAPI-Specification
phero | OpenAPI-Specification | |
---|---|---|
21 | 44 | |
311 | 28,291 | |
0.3% | 0.7% | |
6.5 | 8.7 | |
3 months ago | 5 days ago | |
TypeScript | Markdown | |
Apache License 2.0 | Apache License 2.0 |
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.
phero
-
Node.js 20 is now available
That's one of the reasons that drove me to create Phero: https://phero.dev
-
Full-Stack TypeScript with tRPC and React
I’m one of the authors of Phero. It’s goal is similar to tRPC: fullstack typesafety between servers and clients.
One difference is syntax: Phero leverages the TS compiler api to generate parsers for your backend functions. It will parse input and output or your api, automatically, based on the types you define for your functions. It will generate a declaration file of your api and generate an RPC style client SDK for your frontend. Another difference is that it aims to be more batteries includes.
[1] https://github.com/phero-hq/phero
Comparison: https://phero.dev/docs/comparisons/tRPC
- Framework for REST API that builds a complete-ish API given a model?
-
Using API routes for large projects
Shameless plug: you could also use https://phero.dev
-
No errors when fetched data is a 'string' even though interface property type should be a number.
Long story short: when fetching data, you should be validating the data, before casting it to a type you’re expecting it to be. There are a lot of different approaches for this, but being the go-author my favorite would be Phero (https://phero.dev). With this, you can build your API in typescript as well, automatically generate a client for your frontend to call the API. Phero will make sure all data is correct in runtime, automatically.
-
Best schema validator for intellisense performance?
For those looking for an alternative: Definitely check out https://phero.dev. As the co-creator I’m totally biased of course, but thanks to its build-step IDE-performance is great 😊👍
-
I've made a big comparison table of nodejs RPC frameworks. Hope you like it ;)
What about Phero? https://phero.dev
- How you make typesafe front/backend API
-
KitaJs Survey - No runtime code, fast as bare metal and top level framework.
Can we add Phero to the list? :) https://github.com/phero-hq/phero
-
If you haven't worked with TypeScript yet it's a good time to get started now. I prepared an intro that covers the most important points to React with TS. Including a few embedded exercises for you to practice.
You can use Phero. You can use it on your backend and frontend. It basically created a typed API from your backend afaik
OpenAPI-Specification
-
Writing type safe API clients in TypeScript
And I'll be using the OpenAPI Pet Store spec file as an example.
-
Show HN: OpenAPI DevTools – Chrome ext. that generates an API spec as you browse
I saw your sibling comment about "keeping it simple," however that is a bit counter to "generates OpenAPI specifications" since those for sure are not limited to just application/json request/response bodies
I wanted to draw your attention to "normal" POST application/x-www-form-urlencoded <https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/vers...> and its multipart/form-data friend <https://github.com/OAI/OpenAPI-Specification/blob/3.1.0/vers...>
The latter is likely problematic, but the former is in wide use still, including, strangely enough, the AWS API, although some of their newer services do have an application/json protocol
I know that's a lot of words, but the tl;dr would be that if you want your extension to be application/json only, then changing the description to say "OpenAPI specifications for application/json handshakes" would help the consumer be on the same page with your goals
-
How to Connect a FastAPI Server to PostgreSQL and Deploy on GCP Cloud Run
Since FastAPI is based on OpenAPI, at this point you can also use the automatically generated docs. There are multiple options, and two are included by default. Try them out by accessing the following URLs:
-
Write a scalable OpenAPI specification for a Node.js API
This approach requires a constant context switch and is clearly not productive. Here, the OpenAPI Specification can help; you might already have it, but is it scalable? In this article, we’ll learn how to create an OpenAPI Specification document that is readable, scalable, and follows the principle of extension without modifying the existing document.
-
OpenAPI 3.1 - The Gnarly Bits
Phil Sturgeon, who along with Ben Hutton and Henry Andrews from the JSON Schema community, helped drive the push to full JSON Schema Draft 2020-12 compliance, has written a blog post for the official OpenAPIs.org website on how to transition your OAS documents from v3.0.x to v3.1.0.
-
Documenting Node.js API using Swagger
In this article, we will be learning how to document API written in Node.js using a tool called Swagger. Swagger allows you to describe the structure of your APIs so that machines can read them. The ability of APIs to describe their own structure is the root of all awesomeness in Swagger. Why is it so great? Well, by reading our API’s structure, swagger can automatically build beautiful and interactive API documentation. It can also automatically generate client libraries for your API in many languages and explore other possibilities like automated testing. Swagger does this by asking our API to return a YAML or JSON that contains a detailed description of your entire API. This file is essentially a resource listing of our API which adheres to OpenAPI Specifications.
-
Getting started with REST APIs
You may encounter APIs described as RESTful that do not meet these criteria. This is often the result of bottom-up coding, where top-down design should have been used. Another thing to watch out for is the absence of a schema. There are alternatives, but OpenAPI is a common choice with good tools support. If you don't have a schema, you can create one by building a Postman collection.
-
Automatic request validation at the edge with OpenAPI and Fastly
The principle behind the OpenAPI Specification (OAS – the industry’s most popular API specification format) is similar. It’s supposed to act as a blueprint for describing RESTful APIs.
-
How would I describe a webhook, as part of my API collection?
OpenAPI 3.1 supports webhooks. It's not widely supported yet by implementations, but it's definitely there. https://github.com/OAI/OpenAPI-Specification/blob/main/examples/v3.1/webhook-example.yaml
-
Better Fastly API clients with OpenAPI Generator
The Fastly API is huge. We have lots of customers who want to interact with it using their chosen programming language but our small set of manually maintained clients was not sufficient to handle the job of our ever-evolving API. We needed a way to scale up our API client support, and OpenAPI was the answer.
What are some alternatives?
protoc-gen-validate - Protocol Buffer Validation - Being replaced by github.com/bufbuild/protovalidate
Cypress - Fast, easy and reliable testing for anything that runs in a browser.
withtyped - 🤹 Type-safe RESTful framework for fullstack with all native implementation.
supertest - 🕷 Super-agent driven library for testing node.js HTTP servers using a fluent API. Maintained for @forwardemail, @ladjs, @spamscanner, @breejs, @cabinjs, and @lassjs.
telefunc - Remote Functions. Instead of API.
grpc-gateway - gRPC to JSON proxy generator following the gRPC HTTP spec
bash - Unofficial mirror of bash repository. Updated daily.
api-guidelines - Microsoft REST API Guidelines
jest-extended - Additional Jest matchers 🃏💪
google.aip.dev - API Improvement Proposals. https://aip.dev/
garph - Fullstack GraphQL Framework for TypeScript
redoc - 📘 OpenAPI/Swagger-generated API Reference Documentation