specra-cli 0.3.0

package/templates/book-docs/public/api-specs/postman-example.json

@@ -0,0 +1,205 @@
+{
+  "info": {
+    "name": "Product API",
+    "description": "API for managing products in an e-commerce system (Postman Collection example)",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
+    "version": "1.0.0"
+  },
+  "auth": {
+    "type": "bearer"
+  },
+  "variable": [
+    {
+      "key": "baseUrl",
+      "value": "https://api.store.com/v1",
+      "type": "string"
+    }
+  ],
+  "item": [
+    {
+      "name": "Products",
+      "item": [
+        {
+          "name": "Get All Products",
+          "request": {
+            "method": "GET",
+            "header": [
+              {
+                "key": "Accept",
+                "value": "application/json"
+              }
+            ],
+            "url": {
+              "raw": "{{baseUrl}}/products?category=electronics&limit=10",
+              "host": ["{{baseUrl}}"],
+              "path": ["products"],
+              "query": [
+                {
+                  "key": "category",
+                  "value": "electronics",
+                  "description": "Filter by product category"
+                },
+                {
+                  "key": "limit",
+                  "value": "10",
+                  "description": "Maximum number of products to return"
+                }
+              ]
+            },
+            "description": "Retrieve a list of products with optional filtering"
+          },
+          "response": [
+            {
+              "name": "Success Response",
+              "code": 200,
+              "body": "[\n  {\n    \"id\": \"prod_123\",\n    \"name\": \"Laptop\",\n    \"price\": 999.99,\n    \"category\": \"electronics\",\n    \"inStock\": true\n  },\n  {\n    \"id\": \"prod_456\",\n    \"name\": \"Mouse\",\n    \"price\": 29.99,\n    \"category\": \"electronics\",\n    \"inStock\": true\n  }\n]"
+            }
+          ]
+        },
+        {
+          "name": "Get Product by ID",
+          "request": {
+            "method": "GET",
+            "header": [
+              {
+                "key": "Accept",
+                "value": "application/json"
+              }
+            ],
+            "url": {
+              "raw": "{{baseUrl}}/products/:id",
+              "host": ["{{baseUrl}}"],
+              "path": ["products", ":id"],
+              "variable": [
+                {
+                  "key": "id",
+                  "value": "prod_123",
+                  "description": "Product ID"
+                }
+              ]
+            },
+            "description": "Get a single product by its ID"
+          },
+          "response": [
+            {
+              "name": "Success",
+              "code": 200,
+              "body": "{\n  \"id\": \"prod_123\",\n  \"name\": \"Laptop\",\n  \"price\": 999.99,\n  \"category\": \"electronics\",\n  \"description\": \"High-performance laptop\",\n  \"inStock\": true\n}"
+            },
+            {
+              "name": "Not Found",
+              "code": 404,
+              "body": "{\n  \"error\": \"Product not found\",\n  \"code\": \"PRODUCT_NOT_FOUND\"\n}"
+            }
+          ]
+        },
+        {
+          "name": "Create Product",
+          "request": {
+            "method": "POST",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              },
+              {
+                "key": "Accept",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"name\": \"Wireless Keyboard\",\n  \"price\": 79.99,\n  \"category\": \"electronics\",\n  \"description\": \"Ergonomic wireless keyboard\",\n  \"inStock\": true\n}"
+            },
+            "url": {
+              "raw": "{{baseUrl}}/products",
+              "host": ["{{baseUrl}}"],
+              "path": ["products"]
+            },
+            "description": "Create a new product in the catalog"
+          },
+          "response": [
+            {
+              "name": "Created",
+              "code": 201,
+              "body": "{\n  \"id\": \"prod_789\",\n  \"name\": \"Wireless Keyboard\",\n  \"price\": 79.99,\n  \"category\": \"electronics\",\n  \"description\": \"Ergonomic wireless keyboard\",\n  \"inStock\": true,\n  \"createdAt\": \"2024-01-15T10:30:00Z\"\n}"
+            },
+            {
+              "name": "Validation Error",
+              "code": 400,
+              "body": "{\n  \"error\": \"Invalid product data\",\n  \"details\": {\n    \"price\": \"Price must be a positive number\"\n  }\n}"
+            }
+          ]
+        },
+        {
+          "name": "Update Product",
+          "request": {
+            "method": "PATCH",
+            "header": [
+              {
+                "key": "Content-Type",
+                "value": "application/json"
+              }
+            ],
+            "body": {
+              "mode": "raw",
+              "raw": "{\n  \"price\": 89.99,\n  \"inStock\": false\n}"
+            },
+            "url": {
+              "raw": "{{baseUrl}}/products/:id",
+              "host": ["{{baseUrl}}"],
+              "path": ["products", ":id"],
+              "variable": [
+                {
+                  "key": "id",
+                  "value": "prod_123",
+                  "description": "Product ID to update"
+                }
+              ]
+            },
+            "description": "Update specific fields of a product"
+          },
+          "response": [
+            {
+              "name": "Updated",
+              "code": 200,
+              "body": "{\n  \"id\": \"prod_123\",\n  \"name\": \"Laptop\",\n  \"price\": 89.99,\n  \"category\": \"electronics\",\n  \"description\": \"High-performance laptop\",\n  \"inStock\": false,\n  \"updatedAt\": \"2024-01-16T15:45:00Z\"\n}"
+            }
+          ]
+        },
+        {
+          "name": "Delete Product",
+          "request": {
+            "method": "DELETE",
+            "header": [],
+            "url": {
+              "raw": "{{baseUrl}}/products/:id",
+              "host": ["{{baseUrl}}"],
+              "path": ["products", ":id"],
+              "variable": [
+                {
+                  "key": "id",
+                  "value": "prod_123",
+                  "description": "Product ID to delete"
+                }
+              ]
+            },
+            "description": "Delete a product from the catalog"
+          },
+          "response": [
+            {
+              "name": "Deleted",
+              "code": 204,
+              "body": ""
+            },
+            {
+              "name": "Not Found",
+              "code": 404,
+              "body": "{\n  \"error\": \"Product not found\"\n}"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

package/templates/book-docs/public/api-specs/test-api.json

@@ -0,0 +1,256 @@
+{
+  "version": "1.0.0",
+  "title": "Test API",
+  "description": "A simple test API for demonstrating the API documentation system",
+  "baseUrl": "https://jsonplaceholder.typicode.com",
+  "auth": {
+    "type": "apiKey",
+    "description": "This is a public API - no authentication required for testing",
+    "headerName": "X-API-Key"
+  },
+  "endpoints": [
+    {
+      "title": "Get All Posts",
+      "method": "GET",
+      "path": "/posts",
+      "description": "Retrieve a list of all blog posts",
+      "queryParams": [
+        {
+          "name": "_limit",
+          "type": "number",
+          "description": "Limit the number of results",
+          "example": 5
+        },
+        {
+          "name": "userId",
+          "type": "number",
+          "description": "Filter posts by user ID",
+          "example": 1
+        }
+      ],
+      "successResponse": {
+        "status": 200,
+        "description": "List of posts retrieved successfully",
+        "example": [
+          {
+            "userId": 1,
+            "id": 1,
+            "title": "sunt aut facere repellat provident",
+            "body": "quia et suscipit..."
+          },
+          {
+            "userId": 1,
+            "id": 2,
+            "title": "qui est esse",
+            "body": "est rerum tempore vitae..."
+          }
+        ]
+      },
+      "examples": [
+        {
+          "title": "cURL",
+          "language": "bash",
+          "code": "curl https://jsonplaceholder.typicode.com/posts?_limit=5"
+        },
+        {
+          "title": "JavaScript",
+          "language": "javascript",
+          "code": "const response = await fetch('https://jsonplaceholder.typicode.com/posts?_limit=5');\nconst posts = await response.json();\nconsole.log(posts);"
+        },
+        {
+          "title": "Python",
+          "language": "python",
+          "code": "import requests\n\nresponse = requests.get('https://jsonplaceholder.typicode.com/posts', params={'_limit': 5})\nposts = response.json()\nprint(posts)"
+        }
+      ]
+    },
+    {
+      "title": "Get Post by ID",
+      "method": "GET",
+      "path": "/posts/:id",
+      "description": "Retrieve a single post by its ID",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "number",
+          "required": true,
+          "description": "The ID of the post to retrieve",
+          "example": 1
+        }
+      ],
+      "successResponse": {
+        "status": 200,
+        "description": "Post retrieved successfully",
+        "example": {
+          "userId": 1,
+          "id": 1,
+          "title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
+          "body": "quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto"
+        }
+      },
+      "errorResponses": [
+        {
+          "status": 404,
+          "description": "Post not found",
+          "example": {}
+        }
+      ]
+    },
+    {
+      "title": "Create New Post",
+      "method": "POST",
+      "path": "/posts",
+      "description": "Create a new blog post",
+      "body": {
+        "description": "Post data to create",
+        "example": {
+          "title": "My New Post",
+          "body": "This is the content of my new post",
+          "userId": 1
+        }
+      },
+      "successResponse": {
+        "status": 201,
+        "description": "Post created successfully",
+        "example": {
+          "id": 101,
+          "title": "My New Post",
+          "body": "This is the content of my new post",
+          "userId": 1
+        }
+      },
+      "examples": [
+        {
+          "title": "cURL",
+          "language": "bash",
+          "code": "curl -X POST https://jsonplaceholder.typicode.com/posts \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"title\": \"My New Post\",\n    \"body\": \"This is the content\",\n    \"userId\": 1\n  }'"
+        },
+        {
+          "title": "JavaScript",
+          "language": "javascript",
+          "code": "const response = await fetch('https://jsonplaceholder.typicode.com/posts', {\n  method: 'POST',\n  headers: { 'Content-Type': 'application/json' },\n  body: JSON.stringify({\n    title: 'My New Post',\n    body: 'This is the content',\n    userId: 1\n  })\n});\nconst post = await response.json();\nconsole.log(post);"
+        }
+      ]
+    },
+    {
+      "title": "Update Post",
+      "method": "PUT",
+      "path": "/posts/:id",
+      "description": "Update an existing post (replaces all fields)",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "number",
+          "required": true,
+          "description": "The ID of the post to update",
+          "example": 1
+        }
+      ],
+      "body": {
+        "description": "Complete post data",
+        "example": {
+          "id": 1,
+          "title": "Updated Title",
+          "body": "Updated content",
+          "userId": 1
+        }
+      },
+      "successResponse": {
+        "status": 200,
+        "description": "Post updated successfully",
+        "example": {
+          "id": 1,
+          "title": "Updated Title",
+          "body": "Updated content",
+          "userId": 1
+        }
+      }
+    },
+    {
+      "title": "Partially Update Post",
+      "method": "PATCH",
+      "path": "/posts/:id",
+      "description": "Partially update a post (only updates provided fields)",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "number",
+          "required": true,
+          "description": "The ID of the post to update",
+          "example": 1
+        }
+      ],
+      "body": {
+        "description": "Fields to update (all optional)",
+        "example": {
+          "title": "New Title Only"
+        }
+      },
+      "successResponse": {
+        "status": 200,
+        "description": "Post updated successfully",
+        "example": {
+          "userId": 1,
+          "id": 1,
+          "title": "New Title Only",
+          "body": "quia et suscipit..."
+        }
+      }
+    },
+    {
+      "title": "Delete Post",
+      "method": "DELETE",
+      "path": "/posts/:id",
+      "description": "Delete a post",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "number",
+          "required": true,
+          "description": "The ID of the post to delete",
+          "example": 1
+        }
+      ],
+      "successResponse": {
+        "status": 200,
+        "description": "Post deleted successfully",
+        "example": {}
+      }
+    },
+    {
+      "title": "Get Comments for Post",
+      "method": "GET",
+      "path": "/posts/:id/comments",
+      "description": "Retrieve all comments for a specific post",
+      "pathParams": [
+        {
+          "name": "id",
+          "type": "number",
+          "required": true,
+          "description": "The post ID",
+          "example": 1
+        }
+      ],
+      "successResponse": {
+        "status": 200,
+        "description": "Comments retrieved successfully",
+        "example": [
+          {
+            "postId": 1,
+            "id": 1,
+            "name": "id labore ex et quam laborum",
+            "email": "Eliseo@gardner.biz",
+            "body": "laudantium enim quasi est quidem magnam..."
+          },
+          {
+            "postId": 1,
+            "id": 2,
+            "name": "quo vero reiciendis velit similique earum",
+            "email": "Jayne_Kuhic@sydney.com",
+            "body": "est natus enim nihil est dolore omnis..."
+          }
+        ]
+      }
+    }
+  ]
+}