Skip to content

[FEAT] Add OpenAPI (Swagger) Documentation for Core API #64

@omeraplak

Description

@omeraplak

Is your feature request related to a problem? Please describe.

Currently, the VoltAgent Core API (@voltagent/core/server) lacks standardized, interactive documentation. This makes it harder for developers (both internal and external) to discover available endpoints, understand required parameters/schemas, and test API calls easily. Without proper documentation, integrating with or extending the API is less efficient and more prone to errors.

Describe alternatives you've considered

  • Manual documentation (e.g., in Markdown files): Less interactive, harder to keep synchronized with the actual API implementation, doesn't allow for easy testing.
    - Other documentation generation tools: OpenAPI/Swagger is the industry standard and integrates well with Hono via existing libraries.

Additional context

No response

Describe the thing to improve

This feature significantly improves the developer experience for anyone interacting with the VoltAgent Core API. The work involves integrating necessary libraries, defining Zod schemas for requests/responses, refactoring route definitions, and updating the server's landing page and startup logs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions