A Closer Look At API Docs Generated via LiveAPI's AI

I've been working on an engineering tool, LiveAPI, for the past few months with a passionate team of five.

We are primarily focused on automating the documentation generation process.

We believe too many teams spend excessive time setting up API reference generation pipelines—or worse, they skip the work altogether because it requires too much effort.

With LiveAPI, our goal is to provide engineers with a more convenient yet highly effective solution.

Our promise is simple: you connect your Git repositories, and we deliver an always up-to-date documentation link for your repository.

Beyond this foundational feature, we offer numerous valuable tools to help you:

1. Discover APIs in an organized way.
2. Get guidance on how to use those APIs.
3. Auto-generate code that can be copied and pasted into frontends or other projects.
4. Search for APIs (currently within a project, with global search planned).
5. Maximize privacy while maintaining great convenience.

Our ultimate goal is to perfect the product, but as is often the case, it’s still a work in progress.

Let me quickly show you an example document produced for a service called fb_backends:

This entire documentation was automatically generated from a new commit within 2–3 minutes.

Key features highlighted in the screenshot:

1. Organized APIs: Many categories are automatically detected.
2. "Try It" Editor: Built on our open-source Lama2 initiative, this editor lets you test APIs directly in the browser.
3. API Descriptions.
4. Search Box.

Additionally, you can see how I generated JavaScript code from the request with just one click:

Here’s what the search functionality looks like:

While this is functional at a basic level, we recognize there’s significant room for improvement:

1. Improved and more customizable visuals.
2. Automatic SDK generation and downloads.
3. Specification of input/output data structures.
4. Proper support for images in the "Try It" editor.
5. Advanced authentication support.
6. Links to relevant source code locations.
7. Clearer differentiation between API method types.
8. Pre-filled example outputs and better sample input variables.

We are excited to take on these challenges in the coming weeks to significantly enhance customer convenience.

We'd Love to Hear Your Feedback

At Hexmos, we deeply value customer feedback and are eager to listen and improve the product. Here’s a closing question for you:

• How can we improve this API documentation based on your experience with APIs and API documentation?

Let us know in the comments!

Learn More

You can learn more about LiveAPI at:

1. LiveAPI Home
2. How LiveAPI Can Be a Strong Swagger Alternative
3. How LiveAPI Can Act as an Automated Alternative to Redocly