openapi-react-query

v0.2.8

Fast, type-safe @tanstack/react-query client to work with your OpenAPI schema. For more information about how to use this package see README

Latest version published 18 days ago

License: MIT

NPM

GitHub

Package Health Score

95 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.2.8	\|	12/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.7	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.3	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (11,708)

GitHub Stars: 6.11K
Forks: 481
Contributors: 180

Direct Usage Popularity

The npm package openapi-react-query receives a total of 11,708 downloads a week. As such, we scored openapi-react-query popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package openapi-react-query, we found that it has been starred 6,112 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 180
Funding: Yes

A good and healthy external contribution signal for openapi-react-query project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 75
Open PR: 23
Last Release: 18 days ago
Last Commit: 1 day ago

Further analysis of the maintenance status of openapi-react-query based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that openapi-react-query demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 months
Dependencies: 1 Direct
Versions: 23
Install Size: 207 kB
Dist-tags: 1
# of Files: 11
Maintainers: 3
TS Typings: No

openapi-react-query has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

openapi-react-query

openapi-react-query is a type-safe tiny wrapper (1 kb) around @tanstack/react-query to work with OpenAPI schema.

It works by using openapi-fetch and openapi-typescript so you get all the following features:

✅ No typos in URLs or params.
✅ All parameters, request bodies, and responses are type-checked and 100% match your schema
✅ No manual typing of your API
✅ Eliminates any types that hide bugs
✅ Eliminates as type overrides that can also hide bugs

Setup

Install this library along with openapi-fetch and openapi-typescript:

npm i openapi-react-query openapi-fetch
npm i -D openapi-typescript typescript

Next, generate TypeScript types from your OpenAPI schema using openapi-typescript:

npx openapi-typescript ./path/to/api/v1.yaml -o ./src/lib/api/v1.d.ts

Usage

Once your types have been generated from your schema, you can create a fetch client, a react-query client and start querying your API.

import createFetchClient from "openapi-fetch";
import createClient from "openapi-react-query";
import type { paths } from "./my-openapi-3-schema"; // generated by openapi-typescript

const fetchClient = createFetchClient({
  baseUrl: "https://myapi.dev/v1/",
});
const $api = createClient(fetchClient);

const MyComponent = () =&gt; {
  const { data, error, isPending } = $api.useQuery(
    "get",
    "/blogposts/{post_id}",
    {
      params: {
        path: { post_id: 5 },
      },
    }
  );

  if (isPending || !data) return "Loading...";

  if (error) return `An error occurred: ${error.message}`;

  return <div>{data.title}</div>;
};

> You can find more information about createFetchClient in the openapi-fetch documentation.

📓 Docs

View Docs

openapi-react-query dependencies

openapi-typescript-helpers

openapi-react-query development dependencies

msw execa react del-cli esbuild @types/react openapi-fetch openapi-typescript @vitejs/plugin-react react-error-boundary @tanstack/react-query @testing-library/react

FAQs

What is openapi-react-query?

Fast, type-safe @tanstack/react-query client to work with your OpenAPI schema. Visit Snyk Advisor to see a full health score report for openapi-react-query, including popularity, security, maintenance & community analysis.

Is openapi-react-query popular?

The npm package openapi-react-query receives a total of 11,708 weekly downloads. As such, openapi-react-query popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is openapi-react-query well maintained?

We found that openapi-react-query demonstrated a healthy version release cadence and project activity. It has a community of 180 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is openapi-react-query safe to use?

The npm package openapi-react-query was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 December-2024, at 12:12 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (11,708)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

openapi-react-query

Setup

Usage

📓 Docs

openapi-react-query dependencies

openapi-react-query development dependencies

FAQs

What is openapi-react-query?

Is openapi-react-query popular?

Is openapi-react-query well maintained?

Is openapi-react-query safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues