{"id":15091441,"url":"https://github.com/pontjs/pontx","last_synced_at":"2025-04-12T06:22:32.253Z","repository":{"id":196808694,"uuid":"549989481","full_name":"pontjs/pontx","owner":"pontjs","description":"OpenAPI full lifecycle management","archived":false,"fork":false,"pushed_at":"2024-03-18T01:48:17.000Z","size":4825,"stargazers_count":24,"open_issues_count":0,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-12T01:18:52.735Z","etag":null,"topics":["generate","lifecycle","management","mocks","oas","openapi","pont","pontx","sdk","swagger","ts","typescript"],"latest_commit_sha":null,"homepage":"https://www.pontxapi.com","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/pontjs.png","metadata":{"files":{"readme":"README.en-US.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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}},"created_at":"2022-10-12T03:20:14.000Z","updated_at":"2024-04-22T18:10:52.118Z","dependencies_parsed_at":null,"dependency_job_id":"992e783c-2ad6-4f21-9133-2ba604e4d1a7","html_url":"https://github.com/pontjs/pontx","commit_stats":null,"previous_names":["pontjs/pontx"],"tags_count":82,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pontjs%2Fpontx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pontjs%2Fpontx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pontjs%2Fpontx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pontjs%2Fpontx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pontjs","download_url":"https://codeload.github.com/pontjs/pontx/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525929,"owners_count":21118772,"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":["generate","lifecycle","management","mocks","oas","openapi","pont","pontx","sdk","swagger","ts","typescript"],"created_at":"2024-09-25T10:41:07.974Z","updated_at":"2025-04-12T06:22:32.230Z","avatar_url":"https://github.com/pontjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pontx\n\n\u003cp align=\"center\"\u003e\n    \u003cimg width=\"200\" src=\"https://img.alicdn.com/imgextra/i1/O1CN01e19ZVX1FIYhY9k2Gt_!!6000000000464-2-tps-200-200.png\"\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003ePontx\u003c/h1\u003e\n\n[Pontx](https://github.com/pontjs/pontx) is a lightweight pluggable API management tools by [Pontx API Spec](https://github.com/pontjs/pontx/blob/main/packages/pontx-spec/docs/classes/PontSpec.md), which inherit [OAS2](https://swagger.io/specification/v2/) compatibility.\n\nPontx provides service by Pontx CLI、[Pontx VSCode IDE Extension](https://marketplace.visualstudio.com/items?itemName=jasonHzq.vscode-pontx) and Web Platform(WIP).\n\n## Features\n\n* \u003cstrong\u003eSDK generating\u003c/strong\u003e. Pontx generate most popular style SDK like SWR by built-in SDK generate plugin.\n* \u003cstrong\u003eAPI Mocks\u003c/strong\u003e. Pontx will generate mocking data automatically. Pontx SDK will return mocks data through Pontx configuration.\n* \u003cstrong\u003eAPI changement manage\u003c/strong\u003e. Pontx will generate API changement report in detail, and you can update your local `Pontx API Spec` by select granularly changement.\n* \u003cstrong\u003eAPI documentation\u003c/strong\u003e. View clearest and elaborate API documentation in IDE.\n* \u003cstrong\u003eAPI searching\u003c/strong\u003e. Searching API in IDE and then insert snippets or view documentation.\n* \u003cstrong\u003eAPI design\u003c/strong\u003e. Writing Pontx API Spec with real-time documentation preview. Pontx API Spec can be managed by `git` automatically.\n* \u003cstrong\u003eAPI debug\u003c/strong\u003e Support API Debugger in IDE\n\nAll lifecle features can be highly customed with Pontx plugin. [Pontx Plugin Development Guide](https://github.com/pontjs/pontx/blob/main/PluginContribution.md)\n\nEnglish | [简体中文](./README.zh-CN.md)\n\n## Quick Start\n\nConfig a valid `pontx-config.json` in your project, and pontx will automatically activated.\n\n### Pontx Configuration\n\n\n#### Configuration Sample\n\n  ```js\n  // pontx-config.json\n  {\n    \"outDir\": \"../src/pontx-services\",\n    \"plugins\": {\n      // pontx built-in plugin or your custom plugin\n    },\n    \"origins\": [{\n      // Pontx support mulitple origins in one project.\n      // Pontx support OAS2、OAS3 origin by default. You can contribute Pontx Parse Plugin to support other type of origin.\n      \"name\": \"name1\",\n      \"url\": \"myhost/v2/api-docs.json\"\n    }, {\n      \"name\": \"name2\",\n      \"envs\": {\n        \"daily\": \"my-daily-host/v2/api-docs.json\",\n        \"pre\": \"my-pre-host/v2/api-docs.json\",\n        \"prod\": \"myhost/v2/api-docs.json\",\n      },\n      \"env\": \"prod\"\n    }]\n  }\n  ```\n\n  For more Pontx Configuration detail, see the [Pontx Configuration Guide](./docs/Configuration.md).\n\n### Usage\n\n#### VSCode Extension Guide\n\n[Pontx VSCode Extension](https://marketplace.visualstudio.com/items?itemName=jasonHzq.vscode-pontx)\n\n[![Version](https://img.shields.io/visual-studio-marketplace/v/jasonhzq.vscode-pontx)](https://marketplace.visualstudio.com/items?itemName=jasonHzq.vscode-pontx)\n[![Installs](https://img.shields.io/visual-studio-marketplace/i/jasonhzq.vscode-pontx)](https://marketplace.visualstudio.com/items?itemName=jasonHzq.vscode-pontx)\n[![Ratings](https://img.shields.io/visual-studio-marketplace/r/jasonhzq.vscode-pontx)](https://marketplace.visualstudio.com/items?itemName=jasonHzq.vscode-pontx)\n\n * Extension UI Guide\n\n![VSCode Extension Guide](https://img.alicdn.com/imgextra/i3/O1CN01AWodzd1KMkHYgvhiW_!!6000000001150-2-tps-1854-1396.png)\n\n * API changes management\n\n![API changement manage](https://img.alicdn.com/imgextra/i4/O1CN01CJgI7L1Q2wr6VsN3r_!!6000000001919-2-tps-882-366.png)\n\n * API Searching\n\n![API Serching](https://img.alicdn.com/imgextra/i3/O1CN01gcgW4z1iVUcgbdpNK_!!6000000004418-2-tps-1750-532.png)\n\nFor more Pontx VSCode Extension details, see the [Pontx VSCode Extension Guide](./VSCodeExtensionGuide.md).\n\n#### Pontx CLI Guide\n\n##### Installation\n\n```sh\nnpm i pontx-cli -g\n```\n\n##### Guide\n\n* \u003cstrong\u003epontx generate\u003c/strong\u003e Fetch Origin API Spec and generate SDK.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpontjs%2Fpontx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpontjs%2Fpontx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpontjs%2Fpontx/lists"}