API Documentation Converter with WYSIWYG Editor

Resolve Bottlenecks,
Find Innovative SolutionsGenerate Solutions

Solution Overview

Problem

Conventional API documentation systems written in data serialization languages like YAML and JSON lack support for advanced data types, such as embedding images or multimedia, and do not natively integrate with WYSIWYG editors, limiting their ability to generate human-readable and editable documentation.

Innovation Solution

A system and method for programmatically generating API documentation in human-readable format, using a network, control database, content database, configuration file manager, and editor circuit to create a machine-readable API configuration file and a graphical user interface (GUI) that supports WYSIWYG editing, allowing for the generation and modification of API call fields and parameter tables, and binding these to a human-readable and editable document.

Engineering Contradictions & Design Principles

VSEngineering Contradiction Analysis

1Adaptability or versatility

If API documentation is written in data serialization languages like YAML and JSON, then the documentation can be machine-readable and structured, but it lacks support for advanced data types like images or multimedia and does not natively integrate with WYSIWYG editors

Engineering Contradiction:

Improvesupport for advanced data typesVSAvoidWYSIWYG editing capability

Core Design Contradiction:

Adaptability or versatilityVSEase of operation

Solution Approach 1:

The patent introduces an intermediary conversion system that transforms machine-readable API documentation (YAML/JSON) into human-readable formats with WYSIWYG capabilities. The converter reads structured API docs, extracts information, and generates enhanced documentation that supports images, multimedia, and direct editing in WYSIWYG editors, thus bridging the gap between machine readability and user-friendly editing.

Inventive Principle:

Principle #24Intermediary (Mediator)

Solution Approach 2:

The system changes the format parameter of API documentation from strict data serialization languages to a hybrid format that retains machine-readable structures while incorporating human-readable elements. This parameter change enables the documentation to support advanced data types and WYSIWYG editing without losing the structured information needed for API reference.

Inventive Principle:

Principle #35Parameter changes

2Reliability

If multiple teams (API development, content management, editorial, legal) collaborate to create and edit API documentation, then comprehensive and accurate documentation can be achieved, but the number of transmissions and iterations required to publish the documentation increases

Engineering Contradiction:

Improvedocumentation accuracyVSAvoidnumber of transmissions

Core Design Contradiction:

ReliabilityVSLoss of time

Solution Approach 1:

The system performs preliminary conversion of machine-readable API documentation into human-readable format with all necessary content, images, and formatting before the documentation enters the collaborative review process. This preliminary action reduces the need for multiple back-and-forth transmissions between teams, as the documentation is already in its final format and ready for review and approval.

Inventive Principle:

Principle #10Preliminary action

Solution Approach 2:

The converter creates a copy of the machine-readable API documentation in human-readable format, allowing multiple teams to work on the copied version without affecting the original machine-readable source. This copying approach enables parallel collaboration while maintaining the integrity of the source documentation, reducing the need for repeated transmissions.

Inventive Principle:

Principle #26Copying

3Extent of automation

If conventional API documentation systems are used, then the documentation can be generated automatically from API specifications, but the ability to embed images or multimedia and provide interactive editing is limited

Engineering Contradiction:

Improveautomatic documentation generationVSAvoidmultimedia embedding capability

Core Design Contradiction:

Extent of automationVSAdaptability or versatility

Solution Approach 1:

The patent merges the advantages of automatic generation from machine-readable specifications with the capabilities of human-readable WYSIWYG documentation. The system combines structured data extraction from API specs with rich media embedding, interactive editing, and formatted output, creating a hybrid documentation system that retains automation while gaining versatility.

Inventive Principle:

Principle #5Merging (Combining)

Data Source

PatentUS11726780B1System and methods for application programming interface reference documentation updater

Publication Date: 2023.08.15 WELLS FARGO BANK NA

AI summary

Systems, methods, and apparatuses for an application programming interface (API) definition automation system that is structured to programmatically generate API documentation in human-readable format. A control database is structured to retrievably store control documents. A content database is structured to retrievably store control document templates. A configuration file manager circuit is structured to generate an API configuration file in a data serialization language. An editor circuit structured to receive the API configuration file and a first control document that is human-readable. The editor circuit is also structured to generate a user interface that includes an API call executable structured to generate an API call field and a table editor executable structured to generate a parameter table. The editor circuit is also structured to apply a modification to the first control document. A content management system is structured to receive the first control document and generate an output document.