{"id":13485133,"url":"https://github.com/aspida/openapi2aspida","last_synced_at":"2025-10-26T18:38:19.252Z","repository":{"id":37260314,"uuid":"267778684","full_name":"aspida/openapi2aspida","owner":"aspida","description":"Convert OpenAPI 3.0 or Swagger 2.0 definitions into aspida","archived":false,"fork":false,"pushed_at":"2024-09-24T03:50:25.000Z","size":1863,"stargazers_count":185,"open_issues_count":16,"forks_count":34,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-31T07:04:16.924Z","etag":null,"topics":["aspida","openapi","swagger","typescript"],"latest_commit_sha":null,"homepage":"https://github.com/aspida/openapi2aspida","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/aspida.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":"2020-05-29T06:06:07.000Z","updated_at":"2025-03-15T07:32:44.000Z","dependencies_parsed_at":"2024-01-16T07:23:11.244Z","dependency_job_id":"7c378053-bed3-4a51-a178-87d704776223","html_url":"https://github.com/aspida/openapi2aspida","commit_stats":{"total_commits":166,"total_committers":14,"mean_commits":"11.857142857142858","dds":0.5301204819277108,"last_synced_commit":"f3cef5422cb6c3fe484194263fa20226d4c017ee"},"previous_names":[],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspida%2Fopenapi2aspida","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspida%2Fopenapi2aspida/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspida%2Fopenapi2aspida/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aspida%2Fopenapi2aspida/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aspida","download_url":"https://codeload.github.com/aspida/openapi2aspida/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247615377,"owners_count":20967184,"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":["aspida","openapi","swagger","typescript"],"created_at":"2024-07-31T17:01:47.067Z","updated_at":"2025-10-26T18:38:19.202Z","avatar_url":"https://github.com/aspida.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# OpenAPI / Swagger to aspida\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://aspida.github.io/aspida/logos/svg/white.svg\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://aspida.github.io/aspida/logos/svg/black.svg\"\u003e\n  \u003cimg alt=\"aspida logo image\" src=\"https://aspida.github.io/aspida/logos/svg/black.svg\"\u003e\n\u003c/picture\u003e\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/openapi2aspida\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/openapi2aspida\" alt=\"npm version\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/openapi2aspida\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dm/openapi2aspida\" alt=\"npm download\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003eConvert OpenAPI 3.0 and Swagger 2.0 definitions into \u003ca href=\"https://github.com/aspida/aspida/tree/master/packages/aspida\"\u003easpida\u003c/a\u003e.\u003c/p\u003e\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n## Getting Started\n\nCompatible with yaml/json of OpenAPI3.0/Swagger2.0\n\n```sh\n$ mkdir petstore-api\n$ cd petstore-api\n$ npx openapi2aspida -i https://petstore.swagger.io/v2/swagger.json # or ../local-swagger.yaml\n# api/$api.ts was built successfully.\n\n$ npm init -y\n$ npm install @aspida/axios axios typescript ts-node @types/node\n```\n\n`index.ts`\n\n```ts\nimport axiosClient from '@aspida/axios';\nimport api from './api/$api';\nimport type { Pet } from './api/@types';\n(async () =\u003e {\n  const client = api(axiosClient());\n  const petId = 100;\n  const body: Pet = {\n    id: petId,\n    name: 'hoge',\n    photoUrls: [],\n    status: 'available',\n  };\n\n  await client.pet.$post({ body });\n  const pet = await client.pet._petId(petId).$get();\n  console.log(pet);\n})();\n```\n\n`package.json`\n\n```json\n{\n  \"scripts\": {\n    \"start\": \"ts-node index.ts\"\n  }\n}\n```\n\n```sh\n$ npm start\n# { id: 100, name: 'hoge', photoUrls: [], tags: [], status: 'available' }\n```\n\n## Build from config file\n\nCreate config file in project root\n\n`aspida.config.js`\n\n```js\nmodule.exports = {\n  input: 'api', // \"input\" of aspida is \"output\" for openapi2aspida\n  outputEachDir: true, // Generate $api.ts in each endpoint directory\n  openapi: { inputFile: 'https://petstore.swagger.io/v2/swagger.json' },\n};\n```\n\n```sh\n$ npx openapi2aspida\n```\n\n## Cli options\n\n### `-i`, `--input`\n\npath to an OpenAPI spec file for input\n\n### `-o`, `--outputdir`\n\ncan change aspida output directory\n\n### `-c`, `--config`\n\npath to an aspida config file\n\n### `--version`\n\ndisplays version of openapi2aspida\n\n### example\n\n```bash\nnpx openapi2aspida -i=openApi/sample.yaml -o=lib/api/sample\n```\n\n## License\n\nopenapi2aspida is licensed under a [MIT License](https://github.com/aspida/openapi2aspida/blob/master/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faspida%2Fopenapi2aspida","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faspida%2Fopenapi2aspida","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faspida%2Fopenapi2aspida/lists"}