Api Docs Generator API
https://api.findutils.com/api/tools/api-docs-generator/execute Return API documentation generated from a list of endpoints, as Markdown (with table of contents, request/response examples) or as an OpenAPI 3.0.3 JSON specification.
Request body
application/json-
title
string optional
API title. Default
"My API". -
version
string optional
API version string. Default
"1.0.0". -
base_url
string optional
Base URL of the API. Default
"https://api.example.com". -
description
string optional
Short description of the API. Default
"". -
endpoints
array required
Endpoints: objects with method (GET|POST|PUT|PATCH|DELETE), path, and optional summary, description, request_body (JSON text), response_example (JSON text), response_code (default "200").
-
format
string optional
Output format. One of
markdown · openapi. Default"markdown".
Example arguments
Verified{
"title": "Users API",
"endpoints": [
{
"method": "GET",
"path": "/users",
"summary": "List users",
"response_example": {
"users": []
}
}
],
"format": "markdown"
} More Data tools
- Bookmarks Html To Csv Convert a browser bookmarks.html export from Chrome, Firefox, Edge, Safari or any other browser that writes the Netscape bookmark format…
- Bookmarks Json To Html Convert a bookmarks JSON file into a Netscape bookmarks.html that Chrome, Firefox, Edge and Safari import.
- Csv Dedupe Remove duplicate rows from a CSV or TSV table.
- Csv Diff Compare two CSV or TSV tables by key column and list the rows that were added, removed or changed - a table diff, not a line diff, so rows…
- Csv To Bookmarks Html Convert a CSV of links into a Netscape bookmarks.html file that Chrome, Firefox, Edge and Safari import.
- Csv To Json Parse CSV text into an array of objects keyed by the header row.