{"id":14986528,"url":"https://github.com/andrejnemec/openapi-tanstack-query-solid","last_synced_at":"2025-10-08T09:32:03.663Z","repository":{"id":208334048,"uuid":"721381125","full_name":"AndrejNemec/openapi-tanstack-query-solid","owner":"AndrejNemec","description":"Enhanced fork of Orval, this tool generates Tanstack Query hooks from OpenAPI specs only with Solid framework integration.","archived":false,"fork":false,"pushed_at":"2023-11-21T12:58:23.000Z","size":328,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-06T10:49:15.609Z","etag":null,"topics":["axios","open-api","solid","solidjs","tanstack-query","tanstack-solid-query","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AndrejNemec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-21T00:12:44.000Z","updated_at":"2024-08-28T14:51:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"738bfda7-5670-4cbc-8910-997fd166877b","html_url":"https://github.com/AndrejNemec/openapi-tanstack-query-solid","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"4e153838cdaf360afb4be796f3730bc686a9ce5f"},"previous_names":["andrejnemec/openapi-tanstack-query-solid"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrejNemec%2Fopenapi-tanstack-query-solid","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrejNemec%2Fopenapi-tanstack-query-solid/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrejNemec%2Fopenapi-tanstack-query-solid/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AndrejNemec%2Fopenapi-tanstack-query-solid/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AndrejNemec","download_url":"https://codeload.github.com/AndrejNemec/openapi-tanstack-query-solid/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235702515,"owners_count":19032076,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["axios","open-api","solid","solidjs","tanstack-query","tanstack-solid-query","typescript"],"created_at":"2024-09-24T14:13:05.419Z","updated_at":"2025-10-08T09:32:03.655Z","avatar_url":"https://github.com/AndrejNemec.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![npm version](https://badge.fury.io/js/otqs.svg)](https://badge.fury.io/js/otqs)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\n## OpenAPI Generator for Tanstack Query with Solid Integration\n\n\u003ch3 align=\"center\"\u003e\n  This project is fork of \u003ca href=\"https://orval.dev\" target=\"_blank\"\u003eorval.dev\u003c/a\u003e.\n\u003c/h3\u003e\n\n### Code Generation\n\n`otqs` is able to generate client with appropriate type-signatures (TypeScript) from any valid OpenAPI v3 or Swagger v2 specification, either in `yaml` or `json` formats.\n\n`Generate`, `valid`, `cache` and `mock` in your SolidJS applications all with your OpenAPI specification.\n\n---\n\n### Installation\n\n#### For @tanstack/solid-query \u003e= v5.71.9\n\n- **NPM:** `npm install otqs@latest`\n- **YARN:** `yarn add otqs@latest`\n- **PNPM:** `pnpm install otqs@latest`\n\n#### For @tanstack/solid-query \u003e= v5.0.0 and \u003c v5.71.9\n\n- **NPM:** `npm install otqs@1.0.0`\n- **YARN:** `yarn add otqs@1.0.0`\n- **PNPM:** `pnpm install otqs@1.0.0`\n\n---\n\n### Configuration\n\n#### **This package generates code that depends on the following packages:**\n\n- **NPM:** `npm install axios @tanstack/solid-query solid-js`\n- **YARN:** `yarn add axios @tanstack/solid-query solid-js`\n- **PNPM:** `pnpm install axios @tanstack/solid-query solid-js`\n\n**More details:** [solid-query](https://github.com/AndrejNemec/openapi-tanstack-query-solid/tree/master/apps/solid-query-basic-app)\n\n**otqs.config.ts**:\n\n```ts\nimport { defineConfig } from 'otqs';\n\nexport default defineConfig({\n  petstore: {\n    output: {\n      mode: 'split',\n      target: 'src/api/endpoints/petstore-endpoints.ts',\n      schemas: 'src/api/model',\n      client: 'solid-query',\n      mock: true,\n      prettier: true,\n      override: {\n        //Optional\n        mutator: {\n          path: './src/api/mutator/custom-instance.ts',\n          name: 'customInstance',\n        },\n        operations: {\n          listPets: {\n            query: {\n              useQuery: true,\n              useInfinite: true,\n              useInfiniteQueryParam: 'limit',\n            },\n          },\n        },\n      },\n    },\n    input: {\n      target: './petstore.yaml', //or json format\n    },\n  },\n});\n```\n\n**custom-instance.ts**:\n\n```ts\nimport Axios, { AxiosError, AxiosRequestConfig } from 'axios';\n\nexport const AXIOS_INSTANCE = Axios.create({ baseURL: '' });\n\nexport const customInstance = \u003cT\u003e(config: AxiosRequestConfig): Promise\u003cT\u003e =\u003e {\n  const source = Axios.CancelToken.source();\n  const promise = AXIOS_INSTANCE({ ...config, cancelToken: source.token }).then(\n    ({ data }) =\u003e data,\n  );\n\n  // @ts-ignore\n  promise.cancel = () =\u003e {\n    source.cancel('Query was cancelled by Vue Query');\n  };\n\n  return promise;\n};\n\nexport default customInstance;\n\nexport interface ErrorType\u003cError\u003e extends AxiosError\u003cError\u003e {}\n```\n\n---\n\n### Usage\n\nCommand for generate open-api sdk:\n\n```bash\notqs\n```\n\n---\n\n### Example\n\n- [solid-query](https://github.com/AndrejNemec/openapi-tanstack-query-solid/tree/master/apps/solid-query-basic-app)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrejnemec%2Fopenapi-tanstack-query-solid","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrejnemec%2Fopenapi-tanstack-query-solid","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrejnemec%2Fopenapi-tanstack-query-solid/lists"}