axigen 0.1.0 → 0.1.1

package/README.md

@@ -1,109 +1,239 @@
 # axigen
 
-> Generate typed Axios client functions from OpenAPI / Swagger specs
+> Generate typed Axios client functions from your OpenAPI / Swagger spec — in one command.
 
 [![npm version](https://img.shields.io/npm/v/axigen)](https://www.npmjs.com/package/axigen)
 [![license](https://img.shields.io/npm/l/axigen)](./LICENSE)
+[![node](https://img.shields.io/node/v/axigen)](https://nodejs.org)
 
-## نصب
+## Overview
+
+**axigen** reads your OpenAPI (or Swagger) spec and generates fully-typed Axios wrapper functions, so you never have to write boilerplate API calls by hand again.
+
+- ✅ Supports OpenAPI 3.x and Swagger 2.x (YAML or JSON)
+- ✅ Generates typed request/response interfaces
+- ✅ Works with your own Axios instance
+- ✅ TypeScript and JavaScript output
+- ✅ JSDoc comments from your spec's summaries
+- ✅ Filter endpoints by tag
+- ✅ Zero runtime dependencies in generated code
+
+## Installation
 
 ```bash
 npm install -D axigen
-# یا
+# or
 pnpm add -D axigen
+# or
+yarn add -D axigen
 ```
 
-## شروع سریع
+## Quick Start
 
-**۱. ساخت فایل کانفیگ:**
+**1. Create a config file:**
 
 ```bash
 npx axigen init
 ```
 
-**۲. ویرایش `axigen.config.js`:**
+**2. Edit `axigen.config.js`:**
 
 ```js
 /** @type {import('axigen').AxigenConfig} */
 module.exports = {
+  // Path to your OpenAPI spec (YAML or JSON)
   input: "./openapi.yaml",
+
   output: {
+    // Generated Axios client functions
     client: "./src/api/client.ts",
+    // Generated TypeScript types
     types: "./src/api/types.ts",
   },
+
+  // Import path to your Axios instance inside your project
   axiosInstancePath: "../lib/axios",
+
   language: "ts",
   jsdoc: true,
 };
 ```
 
-**۳. Generate:**
+**3. Run:**
 
 ```bash
 npx axigen generate
-# یا کوتاه‌تر:
+# or simply:
 npx axigen
 ```
 
-## خروجی
+---
 
-از این OpenAPI:
+## Example
+
+Given this OpenAPI spec:
 
 ```yaml
 paths:
+  /users:
+    get:
+      operationId: getUsers
+      summary: List all users
+      parameters:
+        - name: page
+          in: query
+          schema:
+            type: integer
+        - name: limit
+          in: query
+          schema:
+            type: integer
+
   /users/{userId}:
     get:
       operationId: getUserById
+      summary: Get a user by ID
+      parameters:
+        - name: userId
+          in: path
+          required: true
+          schema:
+            type: string
+
+    put:
+      operationId: updateUser
+      summary: Update a user
       parameters:
         - name: userId
           in: path
           required: true
+          schema:
+            type: string
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/UpdateUserBody"
 ```
 
-این کد generate میشه:
+axigen generates:
 
 ```ts
+// src/api/client.ts — auto-generated by axigen, do not edit
+
+import type { AxiosResponse } from "axios";
+import { axiosInstance } from "../lib/axios";
+import type {
+  GetUsersQueryParams,
+  GetUsersResponse,
+  GetUserByIdPathParams,
+  GetUserByIdResponse,
+  UpdateUserPathParams,
+  UpdateUserBody,
+  UpdateUserResponse,
+} from "./types";
+
 /**
- * دریافت کاربر با ID
+ * List all users
+ * `GET /users`
+ */
+export async function getUsers(params?: GetUsersQueryParams): Promise<AxiosResponse<GetUsersResponse>> {
+  return axiosInstance.get("/users", { params });
+}
+
+/**
+ * Get a user by ID
  * `GET /users/{userId}`
  */
 export async function getUserById(userId: GetUserByIdPathParams["userId"]): Promise<AxiosResponse<GetUserByIdResponse>> {
   return axiosInstance.get(`/users/${userId}`);
 }
+
+/**
+ * Update a user
+ * `PUT /users/{userId}`
+ */
+export async function updateUser(userId: UpdateUserPathParams["userId"], data: UpdateUserBody): Promise<AxiosResponse<UpdateUserResponse>> {
+  return axiosInstance.put(`/users/${userId}`, data);
+}
+```
+
+---
+
+## Configuration
+
+| Option                | Type           | Default         | Description                                           |
+| --------------------- | -------------- | --------------- | ----------------------------------------------------- |
+| `input`               | `string`       | —               | Path to your OpenAPI spec file (YAML or JSON)         |
+| `output.client`       | `string`       | —               | Output path for the generated client functions        |
+| `output.types`        | `string`       | —               | Output path for generated TypeScript types (optional) |
+| `axiosInstancePath`   | `string`       | —               | Import path to your Axios instance                    |
+| `axiosInstanceExport` | `string`       | `axiosInstance` | Named export of your Axios instance                   |
+| `language`            | `'ts' \| 'js'` | `'ts'`          | Output language                                       |
+| `jsdoc`               | `boolean`      | `true`          | Add JSDoc comments to generated functions             |
+| `tags`                | `string[]`     | —               | Only generate endpoints matching these tags           |
+
+### Axios Instance
+
+axigen does not create an Axios instance for you — it imports the one you already have in your project. For example:
+
+```ts
+// src/lib/axios.ts
+import axios from "axios";
+
+export const axiosInstance = axios.create({
+  baseURL: "https://api.example.com/v1",
+  headers: {
+    "Content-Type": "application/json",
+  },
+});
 ```
 
-## گزینه‌های کانفیگ
+Then in your config:
+
+```js
+axiosInstancePath: '../lib/axios',
+axiosInstanceExport: 'axiosInstance', // default, can be omitted
+```
 
-| گزینه                 | نوع            | پیش‌فرض         | توضیح                               |
-| --------------------- | -------------- | --------------- | ----------------------------------- |
-| `input`               | `string`       | —               | مسیر فایل OpenAPI (yaml یا json)    |
-| `output.client`       | `string`       | —               | مسیر خروجی فایل توابع               |
-| `output.types`        | `string`       | —               | مسیر خروجی فایل types (اختیاری)     |
-| `axiosInstancePath`   | `string`       | —               | مسیر import مربوط به axios instance |
-| `axiosInstanceExport` | `string`       | `axiosInstance` | نام export                          |
-| `language`            | `'ts' \| 'js'` | `'ts'`          | زبان خروجی                          |
-| `jsdoc`               | `boolean`      | `true`          | اضافه کردن JSDoc                    |
-| `tags`                | `string[]`     | —               | فیلتر بر اساس تگ                    |
+---
 
-## دستورات CLI
+## CLI
 
 ```bash
+# Generate client from config (default command)
 axigen generate [--config <path>] [--cwd <path>]
+
+# Create a starter config file
 axigen init
+
+# Show version
 axigen --version
+
+# Show help
 axigen --help
 ```
 
-## استفاده programmatic
+---
+
+## Programmatic Usage
+
+You can also use axigen directly in Node.js scripts:
 
 ```ts
 import { generate, loadConfig } from "axigen";
 
 const config = await loadConfig(process.cwd());
 const result = await generate(config, process.cwd());
-console.log(`Generated ${result.endpointCount} endpoints`);
+
+console.log(`✓ Generated ${result.endpointCount} endpoints`);
+console.log(`  client → ${result.clientPath}`);
+console.log(`  types  → ${result.typesPath}`);
 ```
 
-## لایسنس
+---
+
+## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axigen",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Generate typed Axios client functions from OpenAPI / Swagger specs",
   "keywords": [
     "openapi",