Skip to content

Support for OpenAPI / Swagger specification #19

@FerdiStro

Description

@FerdiStro

Hi,
this looks like a very interesting project.

For API development and improved documentation, I was wondering whether it would be possible to provide an OpenAPI (Swagger) specification, ideally as a YAML file.

Why this could be useful:

  • Better and more accessible documentation via the Swagger Editor or local tools
  • Automatic client code generation for other languages, making it easier to integrate with the API
  • Improved maintainability and consistency of the API contract

Possible next steps:

  • Add OpenAPI specification generation to this project
  • Optionally provide client/server code generation based on the spec

Is this something that fits within the scope and direction of the project, or are there plans to go in a different direction regarding API design and documentation?

Additionally, are there already contribution guidelines available, or do you plan to add them soon?
If this feature is aligned with the project, I’d also be happy to create and contribute an initial OpenAPI YAML specification myself.

Thanks for your work on this project!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions