LiveAPI Devlogs Part-2

sreedeep -

Here, we explore the new features and improvements in LiveAPI from the past month. We've been working tirelessly to bring the product to market.

Creating API docs is time-consuming and exhausting for developers, and keeping them updated is even more challenging. This is where LiveAPI, as a documentation companion, proves invaluable.

Developers rarely have time to document their code properly. Projects are rushed to meet deadlines, this makes documenting the codebase challenging. While Swagger helps, it's not a complete solution; it has considerable setup and maintanace cost. Additionally, an exposed Swagger endpoint can introduce security threats. LiveAPI addresses all these issues. 

LiveAPI focuses on three core values:

  1. Using AI to automate documentation.
  2. Staying up-to-date with revisions and interact with APIs through widget.
  3. Ensuring end-to-end code security.

We also have some great short videos to spark your interest.

Automate Doc Generation With Just a Push

You can connect your projects with GitHub or GitLab, including self-hosted GitLab and public project uploads. For a public repo, simply provide the URL.

Here's a video showing how to prepare your docs in just a few clicks:

If you don’t have any repos or want to experiment with a random public repo, try entering public links here:

Maintenance and Updates are Automatic

You need no manual step to update the docs. LiveAPI will make sure that the doc is always up-to-date with the new changes and updates to the code. Here is how updating happens:

When it comes to code, it's of prime importance that the code is secure. We have a long-term vision of how to achieve this. 

Code Security and Safety. 

We do not use the entire codebase to generate the docs. Instead, docs are generated based on specific files associated with the API endpoints. Using LiveAPI private runners, you can review which files are sent to our servers. These non-intrusive runners only send the necessary files, keeping the rest of your code secure.

At Hexmos, your privacy and data security are our top priorities. Here's how we ensure the safety and confidentiality of your information while using LiveAPI:

  1. Minimal Data Processing

    • Only essential files are analyzed using intelligent detection, reducing unnecessary data exposure.

  2. Enterprise-Level Control

    • Enterprise customers can manage code selection entirely within their infrastructure using LiveAPI Runners, ensuring transparency and control.

  3. No Code Storage or AI Training

    • Your code is processed temporarily, never stored, and never used to train AI models.

  4. Transparency at Every Step

    • Our interface and logs provide full visibility into the files being analyzed, ensuring accountability.

  5. Fine-Grained Data Control

    • Users can configure file exclusions and data restrictions to align with their privacy and compliance needs.

Your Trust, Our Commitment
We guarantee your data remains private and secure, with no compromise on control or transparency. Checkout the full privacy policy here

We can also distinguish code from different organizations you belong to and allow you to invite or add users to your organization. This helps onboard team members or clients to view and collaborate on your docs.

To test whether the API works, we provide a LiveAPI widget that addresses this need.

In addition, we now have a functional landing page with a new design. Check out the product page at hexmos.com/liveapi.

Stay tuned for more updates and features. We welcome new ideas and feedback. If you'd like to try the LiveAPI beta, visit LiveAPI and share your feedback.