{ "openapi": "3.0.0", "info": { "title": "MicroAPIs Text & Data Tools", "description": "A comprehensive suite of text analysis, data transformation, and string manipulation APIs. Summarize text, extract keywords, analyze sentiment, convert between JSON/CSV/Markdown/HTML, and manipulate strings with ease.", "version": "1.0.0", "contact": { "name": "MicroAPIs", "url": "https://microapis.dev" } }, "servers": [ { "url": "https://microapis.dev/api/v1" } ], "paths": { "/text/summarize": { "post": { "tags": ["Text"], "summary": "Summarize text", "description": "Generates a concise summary of the provided text, reducing it to a specified number of sentences while preserving key information.", "operationId": "summarizeText", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["text"], "properties": { "text": { "type": "string", "description": "The text to summarize" }, "maxSentences": { "type": "integer", "description": "Maximum number of sentences in the summary", "default": 3 } } }, "example": { "text": "Artificial intelligence has transformed the way we interact with technology. From voice assistants to recommendation engines, AI is embedded in our daily lives. Machine learning algorithms process vast amounts of data to identify patterns and make predictions. This technology continues to evolve at a rapid pace, with new breakthroughs emerging regularly.", "maxSentences": 2 } } } }, "responses": { "200": { "description": "Text summarized successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "summary": { "type": "string" }, "originalLength": { "type": "integer" }, "summaryLength": { "type": "integer" } } }, "example": { "summary": "Artificial intelligence has transformed the way we interact with technology. Machine learning algorithms process vast amounts of data to identify patterns and make predictions.", "originalLength": 338, "summaryLength": 168 } } } }, "400": { "description": "Bad request - missing or invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/text/keywords": { "post": { "tags": ["Text"], "summary": "Extract keywords from text", "description": "Extracts the most relevant keywords from the provided text, each with a relevance score.", "operationId": "extractKeywords", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["text"], "properties": { "text": { "type": "string", "description": "The text to extract keywords from" }, "limit": { "type": "integer", "description": "Maximum number of keywords to return", "default": 10 } } }, "example": { "text": "Machine learning and artificial intelligence are revolutionizing software development and data science.", "limit": 5 } } } }, "responses": { "200": { "description": "Keywords extracted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "keywords": { "type": "array", "items": { "type": "object", "properties": { "word": { "type": "string" }, "score": { "type": "number" } } } } } }, "example": { "keywords": [ { "word": "machine learning", "score": 0.95 }, { "word": "artificial intelligence", "score": 0.92 }, { "word": "software development", "score": 0.78 }, { "word": "data science", "score": 0.75 }, { "word": "revolutionizing", "score": 0.6 } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/text/sentiment": { "post": { "tags": ["Text"], "summary": "Analyze text sentiment", "description": "Performs sentiment analysis on the provided text, returning a score, label (positive/negative/neutral), and confidence level.", "operationId": "analyzeSentiment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["text"], "properties": { "text": { "type": "string", "description": "The text to analyze" } } }, "example": { "text": "I absolutely love this product! It works perfectly and the customer service is outstanding." } } } }, "responses": { "200": { "description": "Sentiment analyzed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "score": { "type": "number", "description": "Sentiment score from -1 (negative) to 1 (positive)" }, "label": { "type": "string", "enum": ["positive", "negative", "neutral"] }, "confidence": { "type": "number", "description": "Confidence level from 0 to 1" } } }, "example": { "score": 0.92, "label": "positive", "confidence": 0.97 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/text/wordcount": { "post": { "tags": ["Text"], "summary": "Count words, sentences, and more", "description": "Provides a detailed word count analysis including characters, words, sentences, paragraphs, and estimated reading time.", "operationId": "wordCount", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["text"], "properties": { "text": { "type": "string", "description": "The text to analyze" } } }, "example": { "text": "Hello world. This is a sample paragraph.\n\nThis is another paragraph with more text." } } } }, "responses": { "200": { "description": "Word count analysis completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "characters": { "type": "integer" }, "words": { "type": "integer" }, "sentences": { "type": "integer" }, "paragraphs": { "type": "integer" }, "readingTime": { "type": "string" } } }, "example": { "characters": 80, "words": 15, "sentences": 3, "paragraphs": 2, "readingTime": "0 min read" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/text/slug": { "post": { "tags": ["Text"], "summary": "Generate URL slug", "description": "Converts the provided text into a URL-friendly slug by lowercasing, removing special characters, and replacing spaces with hyphens.", "operationId": "generateSlug", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["text"], "properties": { "text": { "type": "string", "description": "The text to convert to a slug" } } }, "example": { "text": "Hello World! This is a Test 123" } } } }, "responses": { "200": { "description": "Slug generated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" } } }, "example": { "slug": "hello-world-this-is-a-test-123" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/data/json-to-csv": { "post": { "tags": ["Data"], "summary": "Convert JSON to CSV", "description": "Converts an array of JSON objects into CSV format with headers derived from the object keys.", "operationId": "jsonToCsv", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "array", "items": { "type": "object" }, "description": "Array of JSON objects to convert" } } }, "example": { "data": [ { "name": "Alice", "age": 30, "city": "New York" }, { "name": "Bob", "age": 25, "city": "London" } ] } } } }, "responses": { "200": { "description": "Converted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string" } } }, "example": { "csv": "name,age,city\nAlice,30,New York\nBob,25,London" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/data/csv-to-json": { "post": { "tags": ["Data"], "summary": "Convert CSV to JSON", "description": "Parses a CSV string into an array of JSON objects using the header row as keys.", "operationId": "csvToJson", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["csv"], "properties": { "csv": { "type": "string", "description": "The CSV string to parse" } } }, "example": { "csv": "name,age,city\nAlice,30,New York\nBob,25,London" } } } }, "responses": { "200": { "description": "Converted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } } } }, "example": { "data": [ { "name": "Alice", "age": "30", "city": "New York" }, { "name": "Bob", "age": "25", "city": "London" } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/data/flatten": { "post": { "tags": ["Data"], "summary": "Flatten nested JSON", "description": "Flattens a deeply nested JSON object into a single-level object with dot-notation keys.", "operationId": "flattenJson", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["data"], "properties": { "data": { "type": "object", "description": "The nested JSON object to flatten" } } }, "example": { "data": { "user": { "name": "Alice", "address": { "city": "New York", "zip": "10001" } } } } } } }, "responses": { "200": { "description": "Flattened successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "flattened": { "type": "object" } } }, "example": { "flattened": { "user.name": "Alice", "user.address.city": "New York", "user.address.zip": "10001" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/data/diff": { "post": { "tags": ["Data"], "summary": "Diff two JSON objects", "description": "Compares two JSON objects and returns a list of changes including additions, deletions, and modifications.", "operationId": "diffJson", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["original", "modified"], "properties": { "original": { "type": "object", "description": "The original JSON object" }, "modified": { "type": "object", "description": "The modified JSON object" } } }, "example": { "original": { "name": "Alice", "age": 30 }, "modified": { "name": "Alice", "age": 31, "city": "New York" } } } } }, "responses": { "200": { "description": "Diff computed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "changes": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "type": { "type": "string" }, "oldValue": {}, "newValue": {} } } } } }, "example": { "changes": [ { "path": "age", "type": "modified", "oldValue": 30, "newValue": 31 }, { "path": "city", "type": "added", "newValue": "New York" } ] } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/convert/md-to-html": { "post": { "tags": ["Convert"], "summary": "Convert Markdown to HTML", "description": "Converts a Markdown string into HTML markup.", "operationId": "markdownToHtml", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["markdown"], "properties": { "markdown": { "type": "string", "description": "The Markdown string to convert" } } }, "example": { "markdown": "# Hello World\n\nThis is **bold** and this is *italic*." } } } }, "responses": { "200": { "description": "Converted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string" } } }, "example": { "html": "

Hello World

This is bold and this is italic.

" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/convert/html-to-text": { "post": { "tags": ["Convert"], "summary": "Convert HTML to plain text", "description": "Strips all HTML tags and returns clean plain text content.", "operationId": "htmlToText", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["html"], "properties": { "html": { "type": "string", "description": "The HTML string to convert" } } }, "example": { "html": "

Hello

This is a paragraph.

" } } } }, "responses": { "200": { "description": "Converted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" } } }, "example": { "text": "Hello\nThis is a paragraph." } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/string/case": { "post": { "tags": ["String"], "summary": "Convert string case", "description": "Converts a string to the specified case format: camelCase, snake_case, kebab-case, PascalCase, or Title Case.", "operationId": "convertCase", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["text", "to"], "properties": { "text": { "type": "string", "description": "The string to convert" }, "to": { "type": "string", "enum": ["camel", "snake", "kebab", "pascal", "title"], "description": "Target case format" } } }, "example": { "text": "hello world example", "to": "camel" } } } }, "responses": { "200": { "description": "Case converted successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "original": { "type": "string" }, "result": { "type": "string" }, "case": { "type": "string" } } }, "example": { "original": "hello world example", "result": "helloWorldExample", "case": "camel" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/string/truncate": { "post": { "tags": ["String"], "summary": "Truncate a string", "description": "Truncates a string to the specified length and appends an optional suffix (default: '...').", "operationId": "truncateString", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["text", "length"], "properties": { "text": { "type": "string", "description": "The string to truncate" }, "length": { "type": "integer", "description": "Maximum length of the result" }, "suffix": { "type": "string", "description": "Suffix to append when truncated", "default": "..." } } }, "example": { "text": "This is a very long string that needs to be shortened", "length": 20, "suffix": "..." } } } }, "responses": { "200": { "description": "String truncated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "original": { "type": "string" }, "truncated": { "type": "string" }, "wasTruncated": { "type": "boolean" } } }, "example": { "original": "This is a very long string that needs to be shortened", "truncated": "This is a very lo...", "wasTruncated": true } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/string/lorem": { "get": { "tags": ["String"], "summary": "Generate Lorem Ipsum text", "description": "Generates placeholder Lorem Ipsum text with the specified number of paragraphs and sentences per paragraph.", "operationId": "generateLorem", "parameters": [ { "name": "paragraphs", "in": "query", "description": "Number of paragraphs to generate", "schema": { "type": "integer", "default": 2 } }, { "name": "sentences", "in": "query", "description": "Number of sentences per paragraph", "schema": { "type": "integer", "default": 4 } } ], "responses": { "200": { "description": "Lorem ipsum text generated", "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "paragraphs": { "type": "integer" }, "sentences": { "type": "integer" } } }, "example": { "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation. Duis aute irure dolor in reprehenderit in voluptate.\n\nExcepteur sint occaecat cupidatat non proident. Sunt in culpa qui officia deserunt mollit anim. Id est laborum et dolore magna aliqua. Consectetur adipiscing elit sed do eiusmod.", "paragraphs": 2, "sentences": 4 } } } } } } }, "/string/count": { "post": { "tags": ["String"], "summary": "Count string components", "description": "Counts the number of characters, words, sentences, and paragraphs in the provided text.", "operationId": "countString", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": ["text"], "properties": { "text": { "type": "string", "description": "The text to analyze" } } }, "example": { "text": "Hello world. This is a test.\n\nAnother paragraph here." } } } }, "responses": { "200": { "description": "Count completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "characters": { "type": "integer" }, "words": { "type": "integer" }, "sentences": { "type": "integer" }, "paragraphs": { "type": "integer" } } }, "example": { "characters": 52, "words": 9, "sentences": 3, "paragraphs": 2 } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string", "description": "Error message" } } } } } }