rapitapir 0.1.0

data/examples/docs/user-api-docs.md

@@ -0,0 +1,403 @@
+# User Management API
+
+Complete API documentation for the User Management system
+
+**Version:** 2.0.0  
+**Base URL:** `https://api.example.com/v2`
+
+---
+
+
+## Table of Contents
+
+- [GET /users](#get-users) - Get all users
+- [GET /users/:id](#get-usersid) - Get user by ID
+- [POST /users](#post-users) - Create new user
+- [PUT /users/:id](#put-usersid) - Update user
+- [DELETE /users/:id](#delete-usersid) - Delete user
+- [GET /users/search](#get-userssearch) - Search users
+
+---
+
+
+## GET /users {#get-users}
+
+**Get all users**
+
+Retrieve a paginated list of all users in the system
+
+### Response
+
+
+
+**Content-Type:** `application/json`
+
+
+
+**Schema:**
+
+```json
+
+[
+  {
+  "id": 123,
+  "name": "example string",
+  "email": "example string",
+  "created_at": "2025-01-15T10:30:00Z"
+}
+]
+
+```
+
+### Example
+
+**Request:**
+```bash
+curl -X GET \\n  -H 'Content-Type: application/json' \\n  -H 'Accept: application/json' \\n  'https://api.example.com/v2/users'
+```
+
+**Response:**
+```json
+[
+  {
+  "id": 123,
+  "name": "example string",
+  "email": "example string",
+  "created_at": "2025-01-15T10:30:00Z"
+}
+]
+```
+
+---
+
+## GET /users/:id {#get-usersid}
+
+**Get user by ID**
+
+Retrieve a specific user by their unique identifier
+
+### Path Parameters
+
+
+
+| Parameter | Type | Description |
+
+|-----------|------|-------------|
+
+| `id` | integer | No description |
+
+### Response
+
+
+
+**Content-Type:** `application/json`
+
+
+
+**Schema:**
+
+```json
+
+{
+  "id": 123,
+  "name": "example string",
+  "email": "example string",
+  "created_at": "2025-01-15T10:30:00Z",
+  "updated_at": "2025-01-15T10:30:00Z"
+}
+
+```
+
+### Example
+
+**Request:**
+```bash
+curl -X GET \\n  -H 'Content-Type: application/json' \\n  -H 'Accept: application/json' \\n  'https://api.example.com/v2/users/123'
+```
+
+**Response:**
+```json
+{
+  "id": 123,
+  "name": "example string",
+  "email": "example string",
+  "created_at": "2025-01-15T10:30:00Z",
+  "updated_at": "2025-01-15T10:30:00Z"
+}
+```
+
+---
+
+## POST /users {#post-users}
+
+**Create new user**
+
+Create a new user account with the provided information
+
+### Request Body
+
+
+
+**Content-Type:** `application/json`
+
+
+
+**Schema:**
+
+```json
+
+{
+  "name": "example string",
+  "email": "example string",
+  "password": "example string"
+}
+
+```
+
+### Response
+
+
+
+**Content-Type:** `application/json`
+
+
+
+**Schema:**
+
+```json
+
+{
+  "id": 123,
+  "name": "example string",
+  "email": "example string",
+  "created_at": "2025-01-15T10:30:00Z"
+}
+
+```
+
+### Example
+
+**Request:**
+```bash
+curl -X POST \\n  -H 'Content-Type: application/json' \\n  -H 'Accept: application/json' \\n  -d '{
+  "name": "example string",
+  "email": "example string",
+  "password": "example string"
+}' \\n  'https://api.example.com/v2/users'
+```
+
+**Response:**
+```json
+{
+  "id": 123,
+  "name": "example string",
+  "email": "example string",
+  "created_at": "2025-01-15T10:30:00Z"
+}
+```
+
+---
+
+## PUT /users/:id {#put-usersid}
+
+**Update user**
+
+Update an existing user's information
+
+### Path Parameters
+
+
+
+| Parameter | Type | Description |
+
+|-----------|------|-------------|
+
+| `id` | integer | No description |
+
+### Request Body
+
+
+
+**Content-Type:** `application/json`
+
+
+
+**Schema:**
+
+```json
+
+{
+  "name": "example string",
+  "email": "example string"
+}
+
+```
+
+### Response
+
+
+
+**Content-Type:** `application/json`
+
+
+
+**Schema:**
+
+```json
+
+{
+  "id": 123,
+  "name": "example string",
+  "email": "example string",
+  "updated_at": "2025-01-15T10:30:00Z"
+}
+
+```
+
+### Example
+
+**Request:**
+```bash
+curl -X PUT \\n  -H 'Content-Type: application/json' \\n  -H 'Accept: application/json' \\n  -d '{
+  "name": "example string",
+  "email": "example string"
+}' \\n  'https://api.example.com/v2/users/123'
+```
+
+**Response:**
+```json
+{
+  "id": 123,
+  "name": "example string",
+  "email": "example string",
+  "updated_at": "2025-01-15T10:30:00Z"
+}
+```
+
+---
+
+## DELETE /users/:id {#delete-usersid}
+
+**Delete user**
+
+Delete a user account permanently
+
+### Path Parameters
+
+
+
+| Parameter | Type | Description |
+
+|-----------|------|-------------|
+
+| `id` | integer | No description |
+
+### Response
+
+
+
+**Content-Type:** `application/json`
+
+
+
+**Schema:**
+
+```json
+
+{
+  "success": true,
+  "message": "example string"
+}
+
+```
+
+### Example
+
+**Request:**
+```bash
+curl -X DELETE \\n  -H 'Content-Type: application/json' \\n  -H 'Accept: application/json' \\n  'https://api.example.com/v2/users/123'
+```
+
+**Response:**
+```json
+{
+  "success": true,
+  "message": "example string"
+}
+```
+
+---
+
+## GET /users/search {#get-userssearch}
+
+**Search users**
+
+Search for users by name or email with pagination support
+
+### Query Parameters
+
+
+
+| Parameter | Type | Required | Description |
+
+|-----------|------|----------|-------------|
+
+| `q` | string | Yes | No description |
+
+| `limit` | integer | No | No description |
+
+| `offset` | integer | No | No description |
+
+### Response
+
+
+
+**Content-Type:** `application/json`
+
+
+
+**Schema:**
+
+```json
+
+{
+  "users": [
+    {
+    "id": 123,
+    "name": "example string",
+    "email": "example string"
+  }
+  ],
+  "total": 123,
+  "limit": 123,
+  "offset": 123
+}
+
+```
+
+### Example
+
+**Request:**
+```bash
+curl -X GET \\n  -H 'Content-Type: application/json' \\n  -H 'Accept: application/json' \\n  'https://api.example.com/v2/users/search?q=example&limit=10&offset=10'
+```
+
+**Response:**
+```json
+{
+  "users": [
+    {
+    "id": 123,
+    "name": "example string",
+    "email": "example string"
+  }
+  ],
+  "total": 123,
+  "limit": 123,
+  "offset": 123
+}
+```
+
+---
+
+*Generated by RapiTapir Documentation Generator*

data/examples/enhanced_auto_derivation_test.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+puts "=== Enhanced Auto-Derivation Testing ==="
+
+require_relative '../lib/rapitapir/types'
+
+# Test JSON Schema with advanced features
+puts "\n1. Advanced JSON Schema Features"
+puts "-" * 40
+
+advanced_schema = {
+  "type" => "object",
+  "properties" => {
+    "id" => { "type" => "integer", "minimum" => 1 },
+    "email" => { "type" => "string", "format" => "email" },
+    "name" => { "type" => "string", "minLength" => 2, "maxLength" => 50 },
+    "age" => { "type" => "integer", "minimum" => 0, "maximum" => 120 },
+    "tags" => { 
+      "type" => "array", 
+      "items" => { "type" => "string" }
+    },
+    "metadata" => { "type" => "object" },
+    "active" => { "type" => "boolean" }
+  },
+  "required" => ["id", "email", "name"]
+}
+
+result = RapiTapir::Types.from_json_schema(advanced_schema)
+puts "✅ Advanced JSON Schema with constraints and formats"
+puts "Fields: #{result.field_types.keys.join(', ')}"
+
+# Test field filtering
+filtered = RapiTapir::Types.from_json_schema(advanced_schema, only: [:id, :name, :email])
+puts "✅ Filtered (only): #{filtered.field_types.keys.join(', ')}"
+
+excluded = RapiTapir::Types.from_json_schema(advanced_schema, except: [:metadata, :tags])
+puts "✅ Filtered (except): #{excluded.field_types.keys.join(', ')}"
+
+# Test OpenStruct with complex data
+puts "\n2. OpenStruct with Complex Data"
+puts "-" * 40
+
+require 'ostruct'
+complex_config = OpenStruct.new(
+  database_url: "postgresql://localhost:5432/mydb",
+  max_connections: 25,
+  ssl_enabled: true,
+  timeout: 30.5,
+  features: ["caching", "logging", "monitoring"],
+  settings: { debug: true, verbose: false }
+)
+
+result = RapiTapir::Types.from_open_struct(complex_config)
+puts "✅ Complex OpenStruct with mixed types"
+puts "Fields: #{result.field_types.keys.join(', ')}"
+
+# Test filtering on OpenStruct
+essential = RapiTapir::Types.from_open_struct(complex_config, only: [:database_url, :max_connections])
+puts "✅ Essential config: #{essential.field_types.keys.join(', ')}"
+
+# Test error handling
+puts "\n3. Error Handling"
+puts "-" * 40
+
+begin
+  RapiTapir::Types.from_json_schema({"type" => "string"})
+rescue ArgumentError => e
+  puts "✅ Proper error for non-object schema: #{e.message}"
+end
+
+begin
+  RapiTapir::Types.from_open_struct("not an ostruct")
+rescue ArgumentError => e
+  puts "✅ Proper error for invalid OpenStruct: #{e.message}"
+end
+
+puts "\n🎉 Enhanced auto-derivation features working!"
+puts "💡 Key benefits:"
+puts "   ✓ Field filtering with only/except"
+puts "   ✓ JSON Schema constraints and formats"
+puts "   ✓ Complex nested types (arrays, objects)"
+puts "   ✓ Proper error handling"