DEV Community

Cover image for Turning a Customer Security Concern into a Feature
LinceMathew
LinceMathew

Posted on

1 1 1 1

Turning a Customer Security Concern into a Feature

We are working on developing a product called LiveAPI, a product for creating automated API docs for any project within minutes and with just a few clicks.

how it works

We are solving many complex problems to convert the idea into a usable product. In this post, I will explain how we are trying to solve a complex problem in our product.

While discussing the idea of LiveAPI with founders and developers, one main concern they kept asking about was the security of the product.

LiveAPI generates API docs directly from GitHub, GitLab, or self-hosted repositories. This requires users to link their GitHub, GitLab, or any other git provider account to LiveAPI.
git providers

As we are a new product with minimal users, people might hesitate to connect their repository or share code with LiveAPI to generate API documentation.

We discussed this problem in the team and came up with the idea of the LiveAPI Runner.

The LiveAPI Runner will act as an agent between the LiveAPI backend and the client. The LiveAPI Runner is a mini-tool that users can install on their own self-hosted server.
For each user, they can enable the LiveAPI Runner and simply install it using a one-line command.

LiveAPI Runner

Using the Runner, users can clone the repositories on their own platform and share the important files with the LiveAPI backend to generate documentation.
Also, they can monitor what files LiveAPI is reading to generate documentation. This will provide complete transparency and clarity on how we are dealing with the user's repository.

Curious about how we implemented this Runner? More details and challenges will be discussed in Part 2.

Sentry blog image

How I fixed 20 seconds of lag for every user in just 20 minutes.

Our AI agent was running 10-20 seconds slower than it should, impacting both our own developers and our early adopters. See how I used Sentry Profiling to fix it in record time.

Read more

Top comments (0)

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs

👋 Kindness is contagious

Dive into an ocean of knowledge with this thought-provoking post, revered deeply within the supportive DEV Community. Developers of all levels are welcome to join and enhance our collective intelligence.

Saying a simple "thank you" can brighten someone's day. Share your gratitude in the comments below!

On DEV, sharing ideas eases our path and fortifies our community connections. Found this helpful? Sending a quick thanks to the author can be profoundly valued.

Okay