GETTING STARTED WITH AUTODOC API

AutoDoc API automatically generates documentation from your source code. You send us your Express.js or FastAPI code, and we return complete endpoint documentation in seconds.

Authentication

No separate authentication is required. Your RapidAPI key handles access automatically when you subscribe to any plan.

Making Your First Request

Send a POST request to /analyze with your source code:


{

  "code": "app.get(\"/users\", getUsers); app.post(\"/login\", login);",

  "language": "nodejs",

  "title": "My API"

}

You will get back a JSON response listing all detected endpoints with descriptions, parameters, and example curl commands.

Available Output Formats

• /analyze - JSON list of endpoints with summaries and example usage
• /openapi - Complete OpenAPI 3.1 specification ready for Swagger or Postman
• /markdown - Formatted Markdown documentation ready for GitHub or Notion

Rate Limits

• Free: 500 requests/month
• Starter: 10,000 requests/month
• Pro: 50,000 requests/month
• Business: 500,000 requests/month

API REFERENCE

GET /
Returns API version, status, and a list of all available endpoints with descriptions. No parameters required.

GET /languages
Returns a list of supported programming languages and frameworks. Currently supports Node.js/Express and Python/FastAPI. More coming soon.

POST /analyze
Analyzes source code and returns all detected API endpoints.

Request Body Parameters:
• code (string, required) - Source code to analyze for API endpoints
• language (string, optional) - "nodejs" or "python". Defaults to "nodejs"
• title (string, optional) - API title for documentation. Defaults to "My API"

Example Response:


{

  "success": true,

  "language": "nodejs",

  "title": "My API",

  "endpoints_found": 3,

  "endpoints": [...]

}

POST /openapi
Generates a complete OpenAPI 3.1 specification from source code. Request body parameters are the same as /analyze. Returns a spec ready to import into Swagger UI, Postman, or Redoc.

POST /markdown
Generates formatted Markdown documentation from source code. Request body parameters are the same as /analyze. Returns a Markdown document ready for GitHub, Notion, or any documentation site.

GET /spec
Returns the OpenAPI 3.1 specification for AutoDoc API itself. This is used by RapidAPI to generate the interactive documentation you see on this page.

SELF-DOCUMENTATION PROOF

We ran AutoDoc API through its own analyzer. It successfully detected all 6 of its own endpoints:

• GET / - API information and health check
• GET /languages - Supported programming languages
• POST /analyze - Analyze source code for endpoints
• POST /openapi - Generate OpenAPI 3.1 specification
• POST /markdown - Generate Markdown documentation
• GET /spec - OpenAPI spec for AutoDoc API itself

This tool documents itself. Try it on your own code and see what it finds.

SUPPORTED FRAMEWORKS

• Node.js / Express.js
• Python / FastAPI

Coming soon: Django, Go Gin, Ruby on Rails, Spring Boot.

PRICING

• Free: $0/month - 500 requests
• Starter: $9.99/month - 10,000 requests
• Pro: $29.99/month - 50,000 requests
• Business: $99.99/month - 500,000 requests

Start free. No credit card required. Upgrade anytime.