openapi-to-postman-complete 0.0.1 → 0.0.2

package/README.md

@@ -0,0 +1,128 @@
+# OpenAPI to Postman Complete
+
+> Complete OpenAPI to Postman converter. One command. Production-ready collections.
+
+[![npm version](https://badge.fury.io/js/openapi-to-postman-complete.svg)](https://www.npmjs.com/package/openapi-to-postman-complete)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Why not just use openapi-to-postmanv2?
+
+The official converter gives you valid Postman collections. We give you **usable** Postman collections.
+
+Built on top of Postman's official `openapi-to-postmanv2` converter, adding:
+
+- **Endpoint filtering** - Keep only what you need
+- **Rich descriptions** - Human-friendly documentation
+- **Real examples** - Actual request/response data
+- **Environment variables** - Dynamic, reusable collections
+- **Auto-generated tests** - Validation out of the box
+
+## Installation
+
+```bash
+npm install -g openapi-to-postman-complete
+```
+
+## Quick Start
+
+```bash
+openapi-to-postman-complete api.yaml config.yaml -o collection.json
+```
+
+That's it. OpenAPI → production-ready Postman collection in one command.
+
+No need to run `openapi-to-postmanv2` separately - we handle that internally.
+
+## Configuration
+
+Create a `config.yaml` with what you need:
+
+### Minimal
+
+```yaml
+variables:
+  environment:
+    baseUrl: https://api.example.com
+
+tests:
+  auto: true
+```
+
+### With Filtering
+
+```yaml
+filter:
+  include:
+    GET /users: true
+    POST /users: true
+
+variables:
+  environment:
+    baseUrl: https://api.example.com
+
+tests:
+  auto: true
+```
+
+### Full Example
+
+```yaml
+filter:
+  include:
+    GET /pets: true
+    POST /pets: true
+    GET /pets/:id: true
+
+descriptions:
+  collection:
+    Pet Store API:
+      name: Pet Store - Developer Collection
+
+  requests:
+    List pets: Get all pets from the store
+
+examples:
+  responses:
+    List pets:
+      code: 200
+      body:
+        - id: '1'
+          name: Buddy
+
+variables:
+  path:
+    id: '{{petId}}'
+  environment:
+    baseUrl: https://api.petstore.com
+    petId: '1'
+
+tests:
+  auto: true
+```
+
+See [examples](./examples) for more.
+
+## Programmatic Usage
+
+```typescript
+import { enrichCollection } from '@openapi-to-postman-complete/core';
+
+const collection = JSON.parse(readFileSync('collection.json', 'utf8'));
+
+const enriched = enrichCollection(collection, {
+  variables: {
+    environment: { baseUrl: 'https://api.example.com' },
+  },
+  tests: { auto: true },
+});
+```
+
+Or load from YAML:
+
+```typescript
+const enriched = enrichCollection(collection, './config.yaml');
+```
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-to-postman-complete",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Complete OpenAPI to Postman converter with filtering, descriptions, examples, variables, and auto-generated tests",
   "keywords": [
     "openapi",
@@ -23,7 +23,8 @@
     "openapi-to-postman-complete": "./dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
   "dependencies": {
     "openapi-to-postmanv2": "^5.5.0",