README.en-US.md

Pontx

Pontx

Pontx is a lightweight pluggable API management tools by Pontx API Spec, which inherit OAS2 compatibility.

Pontx provides service by Pontx CLI、Pontx VSCode IDE Extension and Web Platform(WIP).

Features

• SDK generating. Pontx generate most popular style SDK like SWR by built-in SDK generate plugin.
• API Mocks. Pontx will generate mocking data automatically. Pontx SDK will return mocks data through Pontx configuration.
• API changement manage. Pontx will generate API changement report in detail, and you can update your local Pontx API Spec by select granularly changement.
• API documentation. View clearest and elaborate API documentation in IDE.
• API searching. Searching API in IDE and then insert snippets or view documentation.
• API design. Writing Pontx API Spec with real-time documentation preview. Pontx API Spec can be managed by git automatically.
• API debug Support API Debugger in IDE

All lifecle features can be highly customed with Pontx plugin. Pontx Plugin Development Guide

English | 简体中文

Quick Start

Config a valid pontx-config.json in your project, and pontx will automatically activated.

Pontx Configuration

Configuration Sample

// pontx-config.json
{
  "outDir": "../src/pontx-services",
  "plugins": {
    // pontx built-in plugin or your custom plugin
  },
  "origins": [{
    // Pontx support mulitple origins in one project.
    // Pontx support OAS2、OAS3 origin by default. You can contribute Pontx Parse Plugin to support other type of origin.
    "name": "name1",
    "url": "myhost/v2/api-docs.json"
  }, {
    "name": "name2",
    "envs": {
      "daily": "my-daily-host/v2/api-docs.json",
      "pre": "my-pre-host/v2/api-docs.json",
      "prod": "myhost/v2/api-docs.json",
    },
    "env": "prod"
  }]
}

For more Pontx Configuration detail, see the Pontx Configuration Guide.

Usage

VSCode Extension Guide

Pontx VSCode Extension

• Extension UI Guide

• API changes management

• API Searching

For more Pontx VSCode Extension details, see the Pontx VSCode Extension Guide.

Pontx CLI Guide

Installation

npm i pontx-cli -g

Guide

• pontx generate Fetch Origin API Spec and generate SDK.