Back to HomeBack to Documentation

Using the ApiLens Platform

Learn how to create projects, analyze your APIs, and generate beautiful documentation with ApiLens.

Table of Contents

Getting StartedDashboard OverviewProject ManagementDocumentation Features
Supported FrameworksSharing & CollaborationBest PracticesTroubleshooting

Getting Started

1. Sign Up & Authentication

  1. 1Visit the ApiLens platform and click "Sign in with GitHub"
  2. 2Authorize ApiLens to access your GitHub account
  3. 3Complete your profile setup

2. Create Your First Project

  1. 1Click "New Project" from your dashboard
  2. 2Select a repository from your connected GitHub account
  3. 3Choose project settings (public/private documentation)
  4. 4Click "Create Project" to start the analysis

Dashboard Overview

Dashboard Features

Project Overview:See all your connected repositories
Recent Activity:Track recent documentation updates
Build Status:Monitor analysis progress
Usage Metrics:View documentation views and API calls

Project Management

Project Settings

Configure your project by clicking the settings icon:

Documentation Visibility:Set public or private access
Branch Selection:Choose which branch to analyze
AI Settings:Configure AI enhancement preferences
Webhook Management:View and manage automatic updates

Build Management

Monitor and control documentation builds:

Automatic Builds:Triggered by code pushes (if webhooks are set up)
Manual Builds:Click "Rebuild" to manually trigger analysis
Build History:View past builds and compare changes
Build Status:Track progress with real-time updates

Documentation Features

Enhanced Documentation Viewer

AI-Powered Features

Endpoint Discovery:Automatically detects API endpoints
Smart Descriptions:AI-generated endpoint descriptions
Code Examples:Multi-language request/response examples
Error Documentation:Comprehensive error cases and handling
Related Endpoints:Smart linking between related APIs

Interactive Features

Search & Filter:Find endpoints quickly with advanced search
Syntax Highlighting:Professional code display with Monaco Editor
Copy Examples:One-click copying of code examples
Expandable Sections:Detailed views with collapsible content

Supported Frameworks

Fully Supported

  • Express.js
  • ASP.NET Core
  • Spring Boot

Experimental Support

  • Fastify

Sharing & Collaboration

Public Documentation

Make your API documentation publicly accessible:

  1. 1Go to Project Settings → Sharing
  2. 2Enable "Public Documentation"
  3. 3Copy the public link to share with others
  4. 4Customize the public appearance (optional)

Team Access

Collaborate with your team:

Organization Projects:Automatically shared with org members
Repository Collaborators:Access based on GitHub permissions
Custom Sharing:Share specific documentation links

Best Practices

Code Organization

Clear Route Definitions:Use standard routing patterns
Descriptive Comments:Add JSDoc or docstring comments
Consistent Naming:Use clear, descriptive endpoint names
Error Handling:Implement comprehensive error responses

Documentation Quality

Review AI-generated descriptions for accuracy
Ensure code examples reflect current implementation
Keep documentation updated with code changes
Use the feedback system to improve AI suggestions

Troubleshooting

Common Issues

No Endpoints Detected

Ensure your API follows standard routing patterns. Check that your framework is supported and routes are properly defined.

Build Failures

Check the build logs for specific errors. Common causes include missing dependencies, syntax errors, or unsupported code patterns.

Outdated Documentation

If your documentation isn't updating automatically, check webhook status in project settings or trigger a manual rebuild.

Advanced Features

API Testing (Coming Soon)

Interactive API testing capabilities will include:

Built-in API client for testing endpoints
Authentication management
Request history and collections
Response validation

Export Options

Export your documentation in various formats:

OpenAPI/Swagger JSON
Markdown files
PDF documentation
Postman collections

Need Help?

Join our community Discord, check out our GitHub repository, or contact support for assistance with any issues.

Join DiscordGitHubContact Support